From dde9b27b8ca065b0fc41e245c44baf11cc4bddd8 Mon Sep 17 00:00:00 2001 From: "Vicente.Yu" <^@^> Date: Sat, 19 Oct 2024 21:12:15 +0800 Subject: [PATCH] =?UTF-8?q?=E6=96=B0=E5=A2=9E=20-=20=E3=80=90=E6=99=BA?= =?UTF-8?q?=E8=83=BD=E4=BC=99=E4=BC=B4=E5=88=9B=E5=BB=BA=E5=B9=B3=E5=8F=B0?= =?UTF-8?q?=E3=80=91=E8=8E=B7=E5=8F=96=E6=B6=88=E6=81=AF=20-=20=E3=80=90?= =?UTF-8?q?=E6=99=BA=E8=83=BD=E4=BC=99=E4=BC=B4=E5=88=9B=E5=BB=BA=E5=B9=B3?= =?UTF-8?q?=E5=8F=B0=E3=80=91=E5=88=97=E5=87=BA=E6=B6=88=E6=81=AF=20-=20?= =?UTF-8?q?=E3=80=90=E6=99=BA=E8=83=BD=E4=BC=99=E4=BC=B4=E5=88=9B=E5=BB=BA?= =?UTF-8?q?=E5=B9=B3=E5=8F=B0=E3=80=91=E5=88=9B=E5=BB=BA=E8=BF=90=E8=A1=8C?= =?UTF-8?q?=20-=20=E3=80=90=E6=99=BA=E8=83=BD=E4=BC=99=E4=BC=B4=E5=88=9B?= =?UTF-8?q?=E5=BB=BA=E5=B9=B3=E5=8F=B0=E3=80=91=E5=88=97=E5=87=BA=E8=BF=90?= =?UTF-8?q?=E8=A1=8C=20-=20=E3=80=90=E6=99=BA=E8=83=BD=E4=BC=99=E4=BC=B4?= =?UTF-8?q?=E5=88=9B=E5=BB=BA=E5=B9=B3=E5=8F=B0=E3=80=91=E5=8F=96=E6=B6=88?= =?UTF-8?q?=E8=BF=90=E8=A1=8C=20-=20=E3=80=90=E6=99=BA=E8=83=BD=E4=BC=99?= =?UTF-8?q?=E4=BC=B4=E5=88=9B=E5=BB=BA=E5=B9=B3=E5=8F=B0=E3=80=91=E6=9B=B4?= =?UTF-8?q?=E6=96=B0=E4=BC=9A=E8=AF=9D=20-=20=E3=80=90=E6=99=BA=E8=83=BD?= =?UTF-8?q?=E4=BC=99=E4=BC=B4=E5=88=9B=E5=BB=BA=E5=B9=B3=E5=8F=B0=E3=80=91?= =?UTF-8?q?=E8=8E=B7=E5=8F=96=E4=BC=9A=E8=AF=9D=20-=20=E3=80=90=E6=99=BA?= =?UTF-8?q?=E8=83=BD=E4=BC=99=E4=BC=B4=E5=88=9B=E5=BB=BA=E5=B9=B3=E5=8F=B0?= =?UTF-8?q?=E3=80=91=E5=88=A0=E9=99=A4=E4=BC=9A=E8=AF=9D=20-=20=E3=80=90?= =?UTF-8?q?=E6=99=BA=E8=83=BD=E4=BC=99=E4=BC=B4=E5=88=9B=E5=BB=BA=E5=B9=B3?= =?UTF-8?q?=E5=8F=B0=E3=80=91=E5=8F=91=E9=80=81=E6=B6=88=E6=81=AF=20-=20?= =?UTF-8?q?=E3=80=90=E6=99=BA=E8=83=BD=E4=BC=99=E4=BC=B4=E5=88=9B=E5=BB=BA?= =?UTF-8?q?=E5=B9=B3=E5=8F=B0=E3=80=91=E8=8E=B7=E5=8F=96=E8=BF=90=E8=A1=8C?= =?UTF-8?q?=20-=20=E3=80=90=E6=99=BA=E8=83=BD=E4=BC=99=E4=BC=B4=E5=88=9B?= =?UTF-8?q?=E5=BB=BA=E5=B9=B3=E5=8F=B0=E3=80=91=E5=88=9B=E5=BB=BA=E4=BC=9A?= =?UTF-8?q?=E8=AF=9D=20-=20=E3=80=90=E6=8B=9B=E8=81=98=E3=80=91=E4=BA=BA?= =?UTF-8?q?=E6=89=8D=E8=BF=9B=E5=B1=95=E5=8F=98=E6=9B=B4=E4=BA=8B=E4=BB=B6?= =?UTF-8?q?=20=E4=BA=8B=E4=BB=B6=E4=BD=93=20-=20=E3=80=90=E6=8B=9B?= =?UTF-8?q?=E8=81=98=E3=80=91=E8=8E=B7=E5=8F=96=E4=BA=BA=E6=89=8D=E6=A0=87?= =?UTF-8?q?=E7=AD=BE=E4=BF=A1=E6=81=AF=E5=88=97=E8=A1=A8=20-=20=E3=80=90?= =?UTF-8?q?=E6=8B=9B=E8=81=98=E3=80=91=E6=93=8D=E4=BD=9C=E4=BA=BA=E6=89=8D?= =?UTF-8?q?=E6=A0=87=E7=AD=BE?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 变更 - 获取消息 响应体 - 列出消息 响应体 - 发送消息 响应体 - 员工信息被修改 事件体 Signed-off-by: Vicente.Yu <^@^> --- EventCallbackList.md | 1 + TenantAccessList.md | 106 +-- UserAccessList.md | 68 +- ...ionIdMessagesByAilyMessageIdResponseDto.cs | 47 +- ...sionsByAilySessionIdMessagesResponseDto.cs | 47 +- ...ilyV1SessionsByAilySessionIdResponseDto.cs | 6 +- ...nsByAilySessionIdRunsByRunIdResponseDto.cs | 7 +- ...1SessionsByAilySessionIdRunsResponseDto.cs | 4 + src/Aily/PostAilyV1SessionsBodyDto.cs | 10 +- ...1SessionsByAilySessionIdMessagesBodyDto.cs | 10 +- ...sionsByAilySessionIdMessagesResponseDto.cs | 47 +- ...ilyV1SessionsByAilySessionIdRunsBodyDto.cs | 17 +- ...lySessionIdRunsByRunIdCancelResponseDto.cs | 9 +- ...1SessionsByAilySessionIdRunsResponseDto.cs | 4 + src/Aily/PostAilyV1SessionsResponseDto.cs | 12 +- ...PutAilyV1SessionsByAilySessionIdBodyDto.cs | 4 +- ...ilyV1SessionsByAilySessionIdResponseDto.cs | 6 +- .../GetBitableV1AppsByAppTokenResponseDto.cs | 17 +- src/Base/PostBitableV1AppsBodyDto.cs | 12 +- .../PostBitableV1AppsByAppTokenCopyBodyDto.cs | 14 +- ...tBitableV1AppsByAppTokenCopyResponseDto.cs | 8 +- ...1AppsByAppTokenTablesBatchDeleteBodyDto.cs | 6 +- ...ostBitableV1AppsByAppTokenTablesBodyDto.cs | 36 +- ...ByAppTokenTablesByTableIdRecordsBodyDto.cs | 2 - ...pTokenTablesByTableIdRecordsResponseDto.cs | 2 - ...itableV1AppsByAppTokenTablesResponseDto.cs | 4 +- src/Base/PostBitableV1AppsResponseDto.cs | 12 +- src/Base/PutBitableV1AppsByAppTokenBodyDto.cs | 13 +- .../PutBitableV1AppsByAppTokenResponseDto.cs | 11 +- ...esByTableIdRecordsByRecordIdResponseDto.cs | 2 +- .../ContactUserUpdatedV3EventBodyDto.cs | 23 +- src/Core/EventDto.cs | 4 +- src/Corehr/GetCorehrV2ApproversResponseDto.cs | 6 +- .../PatchCorehrV2PersonsByPersonIdBodyDto.cs | 21 +- ...hrV2BasicInfoTimeZonesSearchResponseDto.cs | 2 +- src/FeishuNetSdk.csproj | 2 +- .../GetCorehrV1CompaniesResponseDto.cs | 4 +- ...tCorehrV1JobDatasByJobDataIdResponseDto.cs | 6 +- ...HireTalentTagSubscriptionV1EventBodyDto.cs | 155 +++++ src/Hire/GetHireV1TalentTagsResponseDto.cs | 120 ++++ .../PostHireV1TalentsByTalentIdTagBodyDto.cs | 42 ++ .../PostHireV1TalentsCombinedUpdateBodyDto.cs | 2 +- ...obRequirementsByJobRequirementIdBodyDto.cs | 2 +- src/IFeishuTenantApi.cs | 603 +++++++++++++++--- src/IFeishuUserApi.cs | 201 ++++-- src/Okr/PostOkrV1ImagesUploadBodyDto.cs | 6 +- src/Okr/PostOkrV1ImagesUploadResponseDto.cs | 2 +- src/Vc/PostVcV1RoomLevelsBodyDto.cs | 2 +- 48 files changed, 1394 insertions(+), 353 deletions(-) create mode 100644 src/Hire.Events/HireTalentTagSubscriptionV1EventBodyDto.cs create mode 100644 src/Hire/GetHireV1TalentTagsResponseDto.cs create mode 100644 src/Hire/PostHireV1TalentsByTalentIdTagBodyDto.cs diff --git a/EventCallbackList.md b/EventCallbackList.md index f6057ef0..35a83e02 100644 --- a/EventCallbackList.md +++ b/EventCallbackList.md @@ -164,6 +164,7 @@ hire.ehr_import_task.imported_v1EventV2Dto<Hire.Events.HireEhrImportTaskImportedV1EventBodyDto>【招聘】导入 e-HR hire.ehr_import_task_for_internship_offer.imported_v1EventV2Dto<Hire.Events.HireEhrImportTaskForInternshipOfferImportedV1EventBodyDto>【招聘】导入 e-HR（实习 Offer） hire.referral_account.assets_update_v1EventV2Dto<Hire.Events.HireReferralAccountAssetsUpdateV1EventBodyDto>【招聘】内推账户余额变更 +hire.talent.tag_subscription_v1EventV2Dto<Hire.Events.HireTalentTagSubscriptionV1EventBodyDto>【招聘】人才进展变更事件 hire.talent.deleted_v1EventV2Dto<Hire.Events.HireTalentDeletedV1EventBodyDto>【招聘】删除人才 hire.application.deleted_v1EventV2Dto<Hire.Events.HireApplicationDeletedV1EventBodyDto>【招聘】删除投递 hire.application.stage_changed_v1EventV2Dto<Hire.Events.HireApplicationStageChangedV1EventBodyDto>【招聘】投递阶段变更 diff --git a/TenantAccessList.md b/TenantAccessList.md index dedbcd02..87f8e01a 100644 --- a/TenantAccessList.md +++ b/TenantAccessList.md @@ -207,13 +207,13 @@ PostDocxV1Documents 1042024-09-24✓云文档获取块的内容 GetDocxV1DocumentsByDocumentIdBlocksByBlockId -1052024-09-24✓云文档创建块 +1052024-10-15✓云文档创建块 PostDocxV1DocumentsByDocumentIdBlocksByBlockIdChildren -1062024-09-24✓云文档更新块的内容 +1062024-10-15✓云文档更新块的内容 PatchDocxV1DocumentsByDocumentIdBlocksByBlockId -1072024-09-24✓云文档批量更新块的内容 +1072024-10-15✓云文档批量更新块的内容 PatchDocxV1DocumentsByDocumentIdBlocksBatchUpdate -1082024-09-19✓云文档删除块 +1082024-10-18✓云文档删除块 DeleteDocxV1DocumentsByDocumentIdBlocksByBlockIdChildrenBatchDelete 1092024-09-24✓云文档获取所有子块 GetDocxV1DocumentsByDocumentIdBlocksByBlockIdChildren @@ -343,27 +343,27 @@ PatchSheetsV3SpreadsheetsBySpreadsheetTokenSheetsBySheetIdFloatImagesByFloatImageId 1722024-09-09✓云文档删除浮动图片 DeleteSheetsV3SpreadsheetsBySpreadsheetTokenSheetsBySheetIdFloatImagesByFloatImageId -1732024-09-18✓多维表格复制多维表格 +1732024-10-18✓多维表格复制多维表格 PostBitableV1AppsByAppTokenCopy -1742024-09-19✓多维表格创建多维表格 +1742024-10-17✓多维表格创建多维表格 PostBitableV1Apps -1752024-09-19✓多维表格获取多维表格元数据 +1752024-10-18✓多维表格获取多维表格元数据 GetBitableV1AppsByAppToken -1762024-04-24✓多维表格更新多维表格元数据 +1762024-10-17✓多维表格更新多维表格元数据 PutBitableV1AppsByAppToken -1772024-09-19✓多维表格新增一个数据表 +1772024-10-18✓多维表格新增一个数据表 PostBitableV1AppsByAppTokenTables -1782024-09-19✓多维表格新增多个数据表 +1782024-10-18✓多维表格新增多个数据表 PostBitableV1AppsByAppTokenTablesBatchCreate -1792024-09-19✓多维表格删除一个数据表 +1792024-10-18✓多维表格删除一个数据表 DeleteBitableV1AppsByAppTokenTablesByTableId 1802024-07-05✓通讯录更新部门所有信息 PutContactV3DepartmentsByDepartmentId -1812024-09-19✓多维表格删除多个数据表 +1812024-10-18✓多维表格删除多个数据表 PostBitableV1AppsByAppTokenTablesBatchDelete -1822023-08-03✓多维表格更新数据表 +1822024-10-18✓多维表格更新数据表 PatchBitableV1AppsByAppTokenTablesByTableId -1832024-09-19✓多维表格列出数据表 +1832024-10-18✓多维表格列出数据表 GetBitableV1AppsByAppTokenTables 1842024-09-18✓多维表格复制仪表盘 PostBitableV1AppsByAppTokenDashboardsByBlockIdCopy @@ -393,13 +393,13 @@ GetBitableV1AppsByAppTokenTablesByTableIdRecordsByRecordId 1972024-09-18✓多维表格列出记录 GetBitableV1AppsByAppTokenTablesByTableIdRecords -1982024-09-20✓多维表格新增记录 +1982024-10-18✓多维表格新增记录 PostBitableV1AppsByAppTokenTablesByTableIdRecords -1992024-09-19✓多维表格更新记录 +1992024-10-18✓多维表格更新记录 PutBitableV1AppsByAppTokenTablesByTableIdRecordsByRecordId 2002024-09-19✓多维表格删除记录 DeleteBitableV1AppsByAppTokenTablesByTableIdRecordsByRecordId -2012024-09-19✓多维表格新增多条记录 +2012024-10-18✓多维表格新增多条记录 PostBitableV1AppsByAppTokenTablesByTableIdRecordsBatchCreate 2022024-07-05✓通讯录获取单个部门信息 GetContactV3DepartmentsByDepartmentId @@ -571,7 +571,7 @@ GetVcV1ExportsByTaskId 2862024-07-23✓视频会议下载导出文件 GetVcV1ExportsDownload -2872024-07-23✓视频会议创建会议室层级 +2872024-10-16✓视频会议创建会议室层级 PostVcV1RoomLevels 2882024-07-23✓视频会议删除会议室层级 PostVcV1RoomLevelsDel @@ -1289,7 +1289,7 @@ GetCorehrV1CountryRegionsByCountryRegionId 6452023-07-14✓飞书人事批量查询国家/地区信息 GetCorehrV1CountryRegions -6462024-10-10✓消息与群组发送消息 +6462024-10-15✓消息与群组发送消息 PostImV1Messages 6472023-07-14✓飞书人事查询单条省份/行政区信息 GetCorehrV1SubdivisionsBySubdivisionId @@ -1311,7 +1311,7 @@ GetCorehrV1EmployeeTypes 6562024-09-23✓飞书人事创建国家证件类型 PostCorehrV1NationalIdTypes -6572024-10-11✓消息与群组回复消息 +6572024-10-15✓消息与群组回复消息 PostImV1MessagesByMessageIdReply 6582024-09-23✓飞书人事删除国家证件类型 DeleteCorehrV1NationalIdTypesByNationalIdTypeId @@ -1351,7 +1351,7 @@ DeleteCorehrV1EmploymentsByEmploymentId 6762024-09-30✓飞书人事（企业版）创建个人信息 PostCorehrV2Persons -6772024-09-30✓飞书人事（企业版）更新个人信息 +6772024-10-17✓飞书人事（企业版）更新个人信息 PatchCorehrV2PersonsByPersonId 6782024-02-06✓飞书人事删除个人信息 DeleteCorehrV1PersonsByPersonId @@ -1367,7 +1367,7 @@ DeleteCorehrV1JobDatasByJobDataId 6842024-10-09✓飞书人事更新任职信息 PatchCorehrV1JobDatasByJobDataId -6852024-09-19✓飞书人事查询单个任职信息 +6852024-10-17✓飞书人事查询单个任职信息 GetCorehrV1JobDatasByJobDataId 6862024-09-19✓飞书人事（企业版）获取任职信息列表 PostCorehrV2EmployeesJobDatasQuery @@ -1411,7 +1411,7 @@ DeleteCorehrV1CompaniesByCompanyId 7062024-09-09✓飞书人事查询单个公司 GetCorehrV1CompaniesByCompanyId -7072024-09-09✓飞书人事批量查询公司 +7072024-10-18✓飞书人事批量查询公司 GetCorehrV1Companies 7082024-10-09✓飞书人事（企业版）通过职级 ID 批量获取职级信息 PostCorehrV2JobLevelsBatchGet @@ -1553,7 +1553,7 @@ PostHireV1JobRequirementsSearch 7772024-09-02✓招聘获取招聘需求列表 GetHireV1JobRequirements -7782024-09-27✓招聘更新招聘需求 +7782024-10-17✓招聘更新招聘需求 PutHireV1JobRequirementsByJobRequirementId 7792024-07-05✓通讯录批量获取用户信息 GetContactV3UsersBatch @@ -1579,7 +1579,7 @@ PutHireV1ExternalApplicationsByExternalApplicationId 7902024-09-09✓招聘删除外部投递 DeleteHireV1ExternalApplicationsByExternalApplicationId -7912024-10-10✓消息与群组批量发送消息 +7912024-10-15✓消息与群组批量发送消息 PostMessageV4BatchSend 7922024-09-09✓招聘创建外部面试 PostHireV1ExternalInterviews @@ -1717,7 +1717,7 @@ PutOkrV1ProgressRecordsByProgressId 8592024-01-09✓OKR获取 OKR 进展记录 GetOkrV1ProgressRecordsByProgressId -8602024-01-09✓OKR上传进展记录图片 +8602024-10-15✓OKR上传进展记录图片 PostOkrV1ImagesUpload 8612023-04-06✓实名认证录入身份信息 PostHumanAuthenticationV1Identities @@ -1755,7 +1755,7 @@ PostPerformanceV1ReviewDatasQuery 8782023-10-25✓词典创建草稿 PostLingoV1Drafts -8792024-10-10✓消息与群组更新应用发送的消息卡片 +8792024-10-15✓消息与群组更新应用发送的消息卡片 PatchImV1MessagesByMessageId 8802023-10-25✓词典更新草稿 PutLingoV1DraftsByDraftId @@ -1779,7 +1779,7 @@ GetLingoV1Repos 8902024-10-10✓通讯录获取部门直属用户列表 GetContactV3UsersFindByDepartment -8912024-09-09✓消息与群组延时更新消息卡片 +8912024-10-14✓消息与群组延时更新消息卡片 PostInteractiveV1CardUpdate 8922023-10-25✓词典上传图片 PostLingoV1FilesUpload @@ -1787,9 +1787,9 @@ GetLingoV1FilesByFileTokenDownload 8942024-04-26✓安全合规获取OpenAPI审计日志数据 PostSecurityAndComplianceV1OpenapiLogsListData -8952024-10-09✓妙记获取妙记统计数据 +8952024-10-18✓妙记获取妙记统计数据 GetMinutesV1MinutesByMinuteTokenStatistics -8962024-10-09✓妙记获取妙记信息 +8962024-10-18✓妙记获取妙记信息 GetMinutesV1MinutesByMinuteToken 8972023-06-29✓工作台获取工作台访问数据 PostWorkplaceV1WorkplaceAccessDataSearch @@ -2053,7 +2053,7 @@ GetCalendarV4CalendarsByCalendarIdEventsInstanceView 10272024-08-28✓招聘获取职位列表 GetHireV1Jobs -10282024-09-24✓多维表格查询记录 +10282024-10-18✓多维表格查询记录 PostBitableV1AppsByAppTokenTablesByTableIdRecordsSearch 10292024-01-26✓应用信息启停用应用 PutApplicationV6ApplicationsByAppIdManagement @@ -2081,7 +2081,7 @@ DeleteImV2AppFeedCardBatch 10412024-08-29✓消息与群组更新消息流卡片按钮 PutImV2ChatButton -10422024-08-29✓消息与群组创建应用消息流卡片 +10422024-10-16✓消息与群组创建应用消息流卡片 PostImV2AppFeedCard 10432024-04-09✓消息与群组解绑标签与群 PutImV2BizEntityTagRelation @@ -2125,7 +2125,7 @@ GetCompensationV1Indicators 10632024-07-12✓薪酬管理批量查询薪资方案 GetCompensationV1Plans -10642024-10-09✓飞书人事（企业版）查询职等 +10642024-10-15✓飞书人事（企业版）查询职等 PostCorehrV2JobGradesQuery 10652024-07-12✓飞书人事批量查询用户授权 GetCorehrV1AuthorizationsQuery @@ -2271,7 +2271,7 @@ PostHireV1JobsByJobIdOpen 11362024-07-22✓招聘添加笔试结果 PostHireV1Exams -11372024-09-12✓招聘更新人才 +11372024-10-15✓招聘更新人才 PostHireV1TalentsCombinedUpdate 11382024-09-09✓招聘创建人才外部信息 PostHireV1TalentsByTalentIdExternalInfo @@ -2421,7 +2421,7 @@ PostApaasV1ApplicationsByNamespaceRecordPermissionsByRecordPermissionApiNameMemberBatchCreateAuthorization 12112024-09-23✓飞书低代码平台批量创建角色成员授权 PostApaasV1ApplicationsByNamespaceRolesByRoleApiNameMemberBatchCreateAuthorization -12122024-10-11✓飞书人事（企业版）获取指定人员审批任务列表 +12122024-10-11删除飞书人事（企业版）获取指定人员审批任务列表 GetCorehrV2Approvers 12132024-10-09✓飞书人事（企业版）删除职等 DeleteCorehrV2JobGradesByJobGradeId @@ -2429,12 +2429,40 @@ PatchCorehrV2JobGradesByJobGradeId 12152024-10-09✓飞书人事（企业版）创建职等 PostCorehrV2JobGrades -12162024-10-11新增云文档创建嵌套块 +12162024-10-15✓云文档创建嵌套块 PostDocxV1DocumentsByDocumentIdBlocksByBlockIdDescendant -12172024-10-10新增绩效更新人员组成员 +12172024-10-10✓绩效更新人员组成员 PostPerformanceV2UserGroupUserRelsWrite -12182024-10-10新增飞书人事（企业版）查询语言信息 +12182024-10-10✓飞书人事（企业版）查询语言信息 PostCorehrV2BasicInfoLanguagesSearch -12192024-10-10新增飞书人事（企业版）查询时区信息 +12192024-10-17✓飞书人事（企业版）查询时区信息 PostCorehrV2BasicInfoTimeZonesSearch +12202024-10-14新增智能伙伴创建平台获取消息 +GetAilyV1SessionsByAilySessionIdMessagesByAilyMessageId +12212024-10-14新增智能伙伴创建平台列出消息 +GetAilyV1SessionsByAilySessionIdMessages +12222024-10-14新增智能伙伴创建平台创建运行 +PostAilyV1SessionsByAilySessionIdRuns +12232024-10-14新增智能伙伴创建平台列出运行 +GetAilyV1SessionsByAilySessionIdRuns +12242024-10-14新增智能伙伴创建平台取消运行 +PostAilyV1SessionsByAilySessionIdRunsByRunIdCancel +12252024-10-14新增智能伙伴创建平台更新会话 +PutAilyV1SessionsByAilySessionId +12262024-10-14新增智能伙伴创建平台获取会话 +GetAilyV1SessionsByAilySessionId +12272024-10-14新增智能伙伴创建平台删除会话 +DeleteAilyV1SessionsByAilySessionId +12282024-10-14新增智能伙伴创建平台发送消息 +PostAilyV1SessionsByAilySessionIdMessages +12292024-10-14新增智能伙伴创建平台获取运行 +GetAilyV1SessionsByAilySessionIdRunsByRunId +12302024-10-14新增智能伙伴创建平台创建会话 +PostAilyV1Sessions +12312024-10-18新增招聘获取人才标签信息列表 +GetHireV1TalentTags +12322024-10-18新增招聘操作人才标签 +PostHireV1TalentsByTalentIdTag +12332024-10-17新增飞书人事（企业版）获取指定人员审批任务列表 +GetCorehrV2Approvers diff --git a/UserAccessList.md b/UserAccessList.md index 0c7fc406..d8057f18 100644 --- a/UserAccessList.md +++ b/UserAccessList.md @@ -29,13 +29,13 @@ GetContactV3JobTitlesByJobTitleId 152024-09-24✓云文档获取块的内容 GetDocxV1DocumentsByDocumentIdBlocksByBlockId -162024-09-24✓云文档创建块 +162024-10-15✓云文档创建块 PostDocxV1DocumentsByDocumentIdBlocksByBlockIdChildren -172024-09-24✓云文档更新块的内容 +172024-10-15✓云文档更新块的内容 PatchDocxV1DocumentsByDocumentIdBlocksByBlockId -182024-09-24✓云文档批量更新块的内容 +182024-10-15✓云文档批量更新块的内容 PatchDocxV1DocumentsByDocumentIdBlocksBatchUpdate -192024-09-19✓云文档删除块 +192024-10-18✓云文档删除块 DeleteDocxV1DocumentsByDocumentIdBlocksByBlockIdChildrenBatchDelete 202024-09-24✓云文档获取所有子块 GetDocxV1DocumentsByDocumentIdBlocksByBlockIdChildren @@ -135,7 +135,7 @@ DeleteSheetsV2SpreadsheetsBySpreadsheetTokenProtectedRangeBatchDel 682024-08-14✓云文档查询下拉列表设置 GetSheetsV2SpreadsheetsBySpreadsheetTokenDataValidation -692024-10-10✓消息与群组更新应用发送的消息卡片 +692024-10-15✓消息与群组更新应用发送的消息卡片 PatchImV1MessagesByMessageId 702024-08-14✓云文档设置下拉列表 PostSheetsV2SpreadsheetsBySpreadsheetTokenDataValidation @@ -163,27 +163,27 @@ PatchSheetsV3SpreadsheetsBySpreadsheetTokenSheetsBySheetIdFloatImagesByFloatImageId 822024-09-09✓云文档删除浮动图片 DeleteSheetsV3SpreadsheetsBySpreadsheetTokenSheetsBySheetIdFloatImagesByFloatImageId -832024-09-18✓多维表格复制多维表格 +832024-10-18✓多维表格复制多维表格 PostBitableV1AppsByAppTokenCopy -842024-09-19✓多维表格创建多维表格 +842024-10-17✓多维表格创建多维表格 PostBitableV1Apps -852024-09-19✓多维表格获取多维表格元数据 +852024-10-18✓多维表格获取多维表格元数据 GetBitableV1AppsByAppToken -862024-04-24✓多维表格更新多维表格元数据 +862024-10-17✓多维表格更新多维表格元数据 PutBitableV1AppsByAppToken -872024-09-19✓多维表格新增一个数据表 +872024-10-18✓多维表格新增一个数据表 PostBitableV1AppsByAppTokenTables -882024-09-19✓多维表格新增多个数据表 +882024-10-18✓多维表格新增多个数据表 PostBitableV1AppsByAppTokenTablesBatchCreate -892024-09-19✓多维表格删除一个数据表 +892024-10-18✓多维表格删除一个数据表 DeleteBitableV1AppsByAppTokenTablesByTableId -902024-09-19✓多维表格删除多个数据表 +902024-10-18✓多维表格删除多个数据表 PostBitableV1AppsByAppTokenTablesBatchDelete 912024-08-21✓消息与群组删除消息表情回复 DeleteImV1MessagesByMessageIdReactionsByReactionId -922023-08-03✓多维表格更新数据表 +922024-10-18✓多维表格更新数据表 PatchBitableV1AppsByAppTokenTablesByTableId -932024-09-19✓多维表格列出数据表 +932024-10-18✓多维表格列出数据表 GetBitableV1AppsByAppTokenTables 942024-09-18✓多维表格复制仪表盘 PostBitableV1AppsByAppTokenDashboardsByBlockIdCopy @@ -213,13 +213,13 @@ GetBitableV1AppsByAppTokenTablesByTableIdRecordsByRecordId 1072024-09-18✓多维表格列出记录 GetBitableV1AppsByAppTokenTablesByTableIdRecords -1082024-09-20✓多维表格新增记录 +1082024-10-18✓多维表格新增记录 PostBitableV1AppsByAppTokenTablesByTableIdRecords -1092024-09-19✓多维表格更新记录 +1092024-10-18✓多维表格更新记录 PutBitableV1AppsByAppTokenTablesByTableIdRecordsByRecordId 1102024-09-19✓多维表格删除记录 DeleteBitableV1AppsByAppTokenTablesByTableIdRecordsByRecordId -1112024-09-19✓多维表格新增多条记录 +1112024-10-18✓多维表格新增多条记录 PostBitableV1AppsByAppTokenTablesByTableIdRecordsBatchCreate 1122024-09-19✓多维表格更新多条记录 PostBitableV1AppsByAppTokenTablesByTableIdRecordsBatchUpdate @@ -727,7 +727,7 @@ PutOkrV1ProgressRecordsByProgressId 3642024-01-09✓OKR获取 OKR 进展记录 GetOkrV1ProgressRecordsByProgressId -3652024-01-09✓OKR上传进展记录图片 +3652024-10-15✓OKR上传进展记录图片 PostOkrV1ImagesUpload 3662024-08-02✓绩效获取周期任务（指定用户） PostPerformanceV1StageTasksFindByUserList @@ -763,9 +763,9 @@ PostLingoV1FilesUpload 3822023-10-25✓词典下载图片 GetLingoV1FilesByFileTokenDownload -3832024-10-09✓妙记获取妙记统计数据 +3832024-10-18✓妙记获取妙记统计数据 GetMinutesV1MinutesByMinuteTokenStatistics -3842024-10-09✓妙记获取妙记信息 +3842024-10-18✓妙记获取妙记信息 GetMinutesV1MinutesByMinuteToken 3852023-04-07✓应用信息获取用户自定义常用的应用 GetApplicationV5ApplicationsFavourite @@ -987,31 +987,31 @@ DeleteAcsV1VisitorsByVisitorId 4942024-07-16✓日历查询日程视图 GetCalendarV4CalendarsByCalendarIdEventsInstanceView -4952024-09-24✓多维表格查询记录 +4952024-10-18✓多维表格查询记录 PostBitableV1AppsByAppTokenTablesByTableIdRecordsSearch 4962024-02-27✓画板获取所有节点 GetBoardV1WhiteboardsByWhiteboardIdNodes -4972024-04-25✓智能伙伴创建平台获取消息 +4972024-10-18✓智能伙伴创建平台获取消息 GetAilyV1SessionsByAilySessionIdMessagesByAilyMessageId -4982024-04-25✓智能伙伴创建平台列出消息 +4982024-10-18✓智能伙伴创建平台列出消息 GetAilyV1SessionsByAilySessionIdMessages -4992024-04-25✓智能伙伴创建平台创建运行 +4992024-10-18✓智能伙伴创建平台创建运行 PostAilyV1SessionsByAilySessionIdRuns -5002024-04-25✓智能伙伴创建平台列出运行 +5002024-10-18✓智能伙伴创建平台列出运行 GetAilyV1SessionsByAilySessionIdRuns -5012024-04-25✓智能伙伴创建平台取消运行 +5012024-10-18✓智能伙伴创建平台取消运行 PostAilyV1SessionsByAilySessionIdRunsByRunIdCancel -5022024-04-25✓智能伙伴创建平台更新会话 +5022024-10-18✓智能伙伴创建平台更新会话 PutAilyV1SessionsByAilySessionId -5032024-04-25✓智能伙伴创建平台获取会话 +5032024-10-18✓智能伙伴创建平台获取会话 GetAilyV1SessionsByAilySessionId -5042024-04-25✓智能伙伴创建平台删除会话 +5042024-10-18✓智能伙伴创建平台删除会话 DeleteAilyV1SessionsByAilySessionId -5052024-04-25✓智能伙伴创建平台发送消息 +5052024-10-18✓智能伙伴创建平台发送消息 PostAilyV1SessionsByAilySessionIdMessages -5062024-04-25✓智能伙伴创建平台获取运行 +5062024-10-18✓智能伙伴创建平台获取运行 GetAilyV1SessionsByAilySessionIdRunsByRunId -5072024-04-25✓智能伙伴创建平台创建会话 +5072024-10-18✓智能伙伴创建平台创建会话 PostAilyV1Sessions 5082024-08-22✓薪酬管理批量查询员工薪资档案 PostCompensationV1ArchivesQuery @@ -1057,6 +1057,6 @@ GetApaasV1ApplicationsByNamespaceAuditLog 5292024-09-26✓汇报查询任务 PostReportV1TasksQuery -5302024-10-11新增云文档创建嵌套块 +5302024-10-15✓云文档创建嵌套块 PostDocxV1DocumentsByDocumentIdBlocksByBlockIdDescendant diff --git a/src/Aily/GetAilyV1SessionsByAilySessionIdMessagesByAilyMessageIdResponseDto.cs b/src/Aily/GetAilyV1SessionsByAilySessionIdMessagesByAilyMessageIdResponseDto.cs index 94ded1cf..b15884cc 100644 --- a/src/Aily/GetAilyV1SessionsByAilySessionIdMessagesByAilyMessageIdResponseDto.cs +++ b/src/Aily/GetAilyV1SessionsByAilySessionIdMessagesByAilyMessageIdResponseDto.cs @@ -4,7 +4,7 @@ // Created : 2024-06-24 // // Last Modified By : yxr -// Last Modified On : 2024-06-24 +// Last Modified On : 2024-10-18 // ************************************************************************ // // MIT @@ -15,6 +15,10 @@ namespace FeishuNetSdk.Aily; /// /// 获取消息 响应体 /// 该 API 用于获取某个飞书智能伙伴应用的消息（Message）的详细信息；包括消息的内容、发送人等。 +/// ## 实体概念说明 +/// - **会话**（Session）：管理用户与 Aily 助手之间的交互会话；每次会话记录了用户发送给 Aily 助手的消息以及 Aily 助手的响应。 +/// - **消息**（Message）：消息可以包含文本、表格、图片等多种类型的内容。 +/// - **运行**（Run）：Aily 助手基于会话内消息进行意图判定、调用匹配的技能，并返回技能执行后的结果消息。 /// 接口ID：7358047310868152324 /// 文档地址：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session-aily_message/get /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2faily-v1%2faily_session-aily_message%2fget @@ -144,6 +148,39 @@ public record AilyMessageFile /// [JsonPropertyName("created_at")] public string? CreatedAt { get; set; } + + /// + /// 文件预览链接 + /// 必填：否 + /// + [JsonPropertyName("preview_url")] + public AilyMessageFilePreview? PreviewUrl { get; set; } + + /// + /// 文件预览链接 + /// + public record AilyMessageFilePreview + { + /// + /// 文件的 URL + /// 必填：是 + /// 示例值：http://path_to_file + /// 最大长度：512 + /// 最小长度：0 + /// + [JsonPropertyName("url")] + public string Url { get; set; } = string.Empty; + + /// + /// url 过期时间，秒时间戳 + /// 必填：否 + /// 示例值：1719413169 + /// 最大长度：20 + /// 最小长度：0 + /// + [JsonPropertyName("expired_at")] + public string? ExpiredAt { get; set; } + } } /// @@ -287,5 +324,13 @@ public record AilyMention /// [JsonPropertyName("created_at")] public string? CreatedAt { get; set; } + + /// + /// 状态 + /// 必填：否 + /// 示例值：COMPLETED + /// + [JsonPropertyName("status")] + public string? Status { get; set; } } } diff --git a/src/Aily/GetAilyV1SessionsByAilySessionIdMessagesResponseDto.cs b/src/Aily/GetAilyV1SessionsByAilySessionIdMessagesResponseDto.cs index cb8232b7..085a42d2 100644 --- a/src/Aily/GetAilyV1SessionsByAilySessionIdMessagesResponseDto.cs +++ b/src/Aily/GetAilyV1SessionsByAilySessionIdMessagesResponseDto.cs @@ -4,7 +4,7 @@ // Created : 2024-06-24 // // Last Modified By : yxr -// Last Modified On : 2024-06-24 +// Last Modified On : 2024-10-18 // ************************************************************************ // // MIT @@ -15,6 +15,10 @@ namespace FeishuNetSdk.Aily; /// /// 列出消息 响应体 /// 该 API 用于列出某个飞书智能伙伴应用的某个会话（Session）下消息（Message）的详细信息；包括消息的内容、发送人等。 +/// ## 实体概念说明 +/// - **会话**（Session）：管理用户与 Aily 助手之间的交互会话；每次会话记录了用户发送给 Aily 助手的消息以及 Aily 助手的响应。 +/// - **消息**（Message）：消息可以包含文本、表格、图片等多种类型的内容。 +/// - **运行**（Run）：Aily 助手基于会话内消息进行意图判定、调用匹配的技能，并返回技能执行后的结果消息。 /// 接口ID：7358047310868168708 /// 文档地址：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session-aily_message/list /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2faily-v1%2faily_session-aily_message%2flist @@ -144,6 +148,39 @@ public record AilyMessageFile /// [JsonPropertyName("created_at")] public string? CreatedAt { get; set; } + + /// + /// 文件预览链接 + /// 必填：否 + /// + [JsonPropertyName("preview_url")] + public AilyMessageFilePreview? PreviewUrl { get; set; } + + /// + /// 文件预览链接 + /// + public record AilyMessageFilePreview + { + /// + /// 文件的 URL + /// 必填：是 + /// 示例值：http://path_to_file + /// 最大长度：512 + /// 最小长度：0 + /// + [JsonPropertyName("url")] + public string Url { get; set; } = string.Empty; + + /// + /// url 过期时间，秒时间戳 + /// 必填：否 + /// 示例值：1719413169 + /// 最大长度：20 + /// 最小长度：0 + /// + [JsonPropertyName("expired_at")] + public string? ExpiredAt { get; set; } + } } /// @@ -287,6 +324,14 @@ public record AilyMention /// [JsonPropertyName("created_at")] public string? CreatedAt { get; set; } + + /// + /// 状态 + /// 必填：否 + /// 示例值：COMPLETED + /// + [JsonPropertyName("status")] + public string? Status { get; set; } } /// diff --git a/src/Aily/GetAilyV1SessionsByAilySessionIdResponseDto.cs b/src/Aily/GetAilyV1SessionsByAilySessionIdResponseDto.cs index 0e483196..2fb1219b 100644 --- a/src/Aily/GetAilyV1SessionsByAilySessionIdResponseDto.cs +++ b/src/Aily/GetAilyV1SessionsByAilySessionIdResponseDto.cs @@ -64,7 +64,7 @@ public record AilySession public string ModifiedAt { get; set; } = string.Empty; /// - /// 会话的创建人 + /// 会话的创建人（Aily UserID） /// 必填：是 /// 示例值：1794840334557292 /// 最大长度：20 @@ -74,7 +74,7 @@ public record AilySession public string CreatedBy { get; set; } = string.Empty; /// - /// 渠道上下文 + /// 可自行构造的 Context [上下文变量](https://aily.feishu.cn/hc/1u7kleqg/en70bqqj#6a446d5e)；在 Workflow 技能中可消费这部分全局变量 /// 必填：否 /// 示例值：{} /// 最大长度：255 @@ -84,7 +84,7 @@ public record AilySession public string? ChannelContext { get; set; } /// - /// 其他透传信息 + /// 会话的自定义变量内容，变量数据保存在服务端 Session 中，可在 `GetSession` 时原样返回，无需在 API 调用侧存储 /// 必填：否 /// 示例值：{} /// 最大长度：255 diff --git a/src/Aily/GetAilyV1SessionsByAilySessionIdRunsByRunIdResponseDto.cs b/src/Aily/GetAilyV1SessionsByAilySessionIdRunsByRunIdResponseDto.cs index c422c7fa..31c12856 100644 --- a/src/Aily/GetAilyV1SessionsByAilySessionIdRunsByRunIdResponseDto.cs +++ b/src/Aily/GetAilyV1SessionsByAilySessionIdRunsByRunIdResponseDto.cs @@ -15,6 +15,10 @@ namespace FeishuNetSdk.Aily; /// /// 获取运行 响应体 /// 该 API 用于获取某个飞书智能伙伴应用的运行（Run）的详细信息；包括运行的状态、结束时间等。 +/// ## 实体概念说明 +/// - **会话**（Session）：管理用户与 Aily 助手之间的交互会话；每次会话记录了用户发送给 Aily 助手的消息以及 Aily 助手的响应。 +/// - **消息**（Message）：消息可以包含文本、表格、图片等多种类型的内容。 +/// - **运行**（Run）：Aily 助手基于会话内消息进行意图判定、调用匹配的技能，并返回技能执行后的结果消息。 /// 接口ID：7358047310868299780 /// 文档地址：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session-run/get /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2faily-v1%2faily_session-run%2fget @@ -74,7 +78,8 @@ public record GetAilyV1SessionsByAilySessionIdRunsByRunIdResponseDtoRun public string SessionId { get; set; } = string.Empty; /// - /// 状态 + /// 运行状态；详见 [Run 状态机说明](https://bytedance.larkoffice.com/wiki/UTU6wVTVGigefykjO1acAOOvnNc#part-LGZrdJTUFo5c8XxSpYXcm3oknEd) + /// - 对于 `COMPLETED` 状态的运行、可通过 `ListMessage` 接口获取 Bot 返回的消息内容。 /// 必填：是 /// 示例值：IN_PROGRESS /// diff --git a/src/Aily/GetAilyV1SessionsByAilySessionIdRunsResponseDto.cs b/src/Aily/GetAilyV1SessionsByAilySessionIdRunsResponseDto.cs index 13fc6fcf..fb0bde62 100644 --- a/src/Aily/GetAilyV1SessionsByAilySessionIdRunsResponseDto.cs +++ b/src/Aily/GetAilyV1SessionsByAilySessionIdRunsResponseDto.cs @@ -15,6 +15,10 @@ namespace FeishuNetSdk.Aily; /// /// 列出运行 响应体 /// 该 API 用于列出某个飞书智能伙伴应用的运行（Run）的详细信息；包括状态、结束时间等。 +/// ## 实体概念说明 +/// - **会话**（Session）：管理用户与 Aily 助手之间的交互会话；每次会话记录了用户发送给 Aily 助手的消息以及 Aily 助手的响应。 +/// - **消息**（Message）：消息可以包含文本、表格、图片等多种类型的内容。 +/// - **运行**（Run）：Aily 助手基于会话内消息进行意图判定、调用匹配的技能，并返回技能执行后的结果消息。 /// 接口ID：7358047310868201476 /// 文档地址：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session-run/list /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2faily-v1%2faily_session-run%2flist diff --git a/src/Aily/PostAilyV1SessionsBodyDto.cs b/src/Aily/PostAilyV1SessionsBodyDto.cs index 1d5f1bdc..3cb7f25c 100644 --- a/src/Aily/PostAilyV1SessionsBodyDto.cs +++ b/src/Aily/PostAilyV1SessionsBodyDto.cs @@ -14,7 +14,11 @@ namespace FeishuNetSdk.Aily; /// /// 创建会话 请求体 -/// 该 API 用于创建与某个飞书智能伙伴应用的一次会话（Session）；当创建会话成功后，可以发送消息、创建运行 +/// 该 API 用于创建与某个飞书智能伙伴应用的一次会话（Session）；当创建会话成功后，可以发送消息、创建运行。 +/// ## 实体概念说明 +/// - **会话**（Session）：管理用户与 Aily 助手之间的交互会话；每次会话记录了用户发送给 Aily 助手的消息以及 Aily 助手的响应。 +/// - **消息**（Message）：消息可以包含文本、表格、图片等多种类型的内容。 +/// - **运行**（Run）：Aily 助手基于会话内消息进行意图判定、调用匹配的技能，并返回技能执行后的结果消息。 /// 接口ID：7358047310868316164 /// 文档地址：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session/create /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2faily-v1%2faily_session%2fcreate @@ -22,7 +26,7 @@ namespace FeishuNetSdk.Aily; public record PostAilyV1SessionsBodyDto { /// - /// 渠道上下文 + /// 可自行构造的 Context [上下文变量](https://aily.feishu.cn/hc/1u7kleqg/en70bqqj#6a446d5e)；在 Workflow 技能中可消费这部分全局变量 /// 必填：否 /// 示例值：{} /// 最大长度：255 @@ -32,7 +36,7 @@ public record PostAilyV1SessionsBodyDto public string? ChannelContext { get; set; } /// - /// 其他透传信息 + /// 会话的自定义变量内容，变量数据保存在服务端 Session 中，可在 `GetSession` 时原样返回，无需在 API 调用侧存储 /// 必填：否 /// 示例值：{} /// 最大长度：255 diff --git a/src/Aily/PostAilyV1SessionsByAilySessionIdMessagesBodyDto.cs b/src/Aily/PostAilyV1SessionsByAilySessionIdMessagesBodyDto.cs index 083ba430..82b061f7 100644 --- a/src/Aily/PostAilyV1SessionsByAilySessionIdMessagesBodyDto.cs +++ b/src/Aily/PostAilyV1SessionsByAilySessionIdMessagesBodyDto.cs @@ -15,6 +15,10 @@ namespace FeishuNetSdk.Aily; /// /// 发送消息 请求体 /// 该 API 用于向某个飞书智能伙伴应用发送一条消息（Message）；每个消息从属于一个活跃的会话（Session）。 +/// ## 实体概念说明 +/// - **会话**（Session）：管理用户与 Aily 助手之间的交互会话；每次会话记录了用户发送给 Aily 助手的消息以及 Aily 助手的响应。 +/// - **消息**（Message）：消息可以包含文本、表格、图片等多种类型的内容。 +/// - **运行**（Run）：Aily 助手基于会话内消息进行意图判定、调用匹配的技能，并返回技能执行后的结果消息。 /// 接口ID：7358047310868283396 /// 文档地址：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session-aily_message/create /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2faily-v1%2faily_session-aily_message%2fcreate @@ -22,7 +26,7 @@ namespace FeishuNetSdk.Aily; public record PostAilyV1SessionsByAilySessionIdMessagesBodyDto { /// - /// 幂等id，同一 session 下相同的幂等 id 算一条消息，有效期72h + /// 幂等 ID（如使用 UUID 生成器或时间戳），同一会话下相同的幂等 ID 视为同一个消息（72h） /// 必填：是 /// 示例值：idempotent_id_1 /// 最大长度：64 @@ -32,7 +36,9 @@ public record PostAilyV1SessionsByAilySessionIdMessagesBodyDto public string IdempotentId { get; set; } = string.Empty; /// - /// 消息内容类型 + /// 消息的类型，包括 `MDX` | `TEXT` 等 + /// - `MDX` 能够表达富文本信息结构，可参考 [Aily 消息节点 markdown 语法](https://bytedance.larkoffice.com/wiki/ZlHYw8jJci3o4dkkEZZcybM0nah) + /// - `TEXT` 作为纯文本进行处理 /// 必填：是 /// 示例值：MDX /// diff --git a/src/Aily/PostAilyV1SessionsByAilySessionIdMessagesResponseDto.cs b/src/Aily/PostAilyV1SessionsByAilySessionIdMessagesResponseDto.cs index e8fbe4bd..085b46b6 100644 --- a/src/Aily/PostAilyV1SessionsByAilySessionIdMessagesResponseDto.cs +++ b/src/Aily/PostAilyV1SessionsByAilySessionIdMessagesResponseDto.cs @@ -4,7 +4,7 @@ // Created : 2024-06-24 // // Last Modified By : yxr -// Last Modified On : 2024-06-24 +// Last Modified On : 2024-10-18 // ************************************************************************ // // MIT @@ -15,6 +15,10 @@ namespace FeishuNetSdk.Aily; /// /// 发送消息 响应体 /// 该 API 用于向某个飞书智能伙伴应用发送一条消息（Message）；每个消息从属于一个活跃的会话（Session）。 +/// ## 实体概念说明 +/// - **会话**（Session）：管理用户与 Aily 助手之间的交互会话；每次会话记录了用户发送给 Aily 助手的消息以及 Aily 助手的响应。 +/// - **消息**（Message）：消息可以包含文本、表格、图片等多种类型的内容。 +/// - **运行**（Run）：Aily 助手基于会话内消息进行意图判定、调用匹配的技能，并返回技能执行后的结果消息。 /// 接口ID：7358047310868283396 /// 文档地址：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session-aily_message/create /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2faily-v1%2faily_session-aily_message%2fcreate @@ -144,6 +148,39 @@ public record AilyMessageFile /// [JsonPropertyName("created_at")] public string? CreatedAt { get; set; } + + /// + /// 文件预览链接 + /// 必填：否 + /// + [JsonPropertyName("preview_url")] + public AilyMessageFilePreview? PreviewUrl { get; set; } + + /// + /// 文件预览链接 + /// + public record AilyMessageFilePreview + { + /// + /// 文件的 URL + /// 必填：是 + /// 示例值：http://path_to_file + /// 最大长度：512 + /// 最小长度：0 + /// + [JsonPropertyName("url")] + public string Url { get; set; } = string.Empty; + + /// + /// url 过期时间，秒时间戳 + /// 必填：否 + /// 示例值：1719413169 + /// 最大长度：20 + /// 最小长度：0 + /// + [JsonPropertyName("expired_at")] + public string? ExpiredAt { get; set; } + } } /// @@ -287,5 +324,13 @@ public record AilyMention /// [JsonPropertyName("created_at")] public string? CreatedAt { get; set; } + + /// + /// 状态 + /// 必填：否 + /// 示例值：COMPLETED + /// + [JsonPropertyName("status")] + public string? Status { get; set; } } } diff --git a/src/Aily/PostAilyV1SessionsByAilySessionIdRunsBodyDto.cs b/src/Aily/PostAilyV1SessionsByAilySessionIdRunsBodyDto.cs index 7025fd36..c28a2725 100644 --- a/src/Aily/PostAilyV1SessionsByAilySessionIdRunsBodyDto.cs +++ b/src/Aily/PostAilyV1SessionsByAilySessionIdRunsBodyDto.cs @@ -15,6 +15,10 @@ namespace FeishuNetSdk.Aily; /// /// 创建运行 请求体 /// 该 API 用于在某个飞书智能伙伴应用会话（Session）上创建一次运行（Run）。 +/// ## 实体概念说明 +/// - **会话**（Session）：管理用户与 Aily 助手之间的交互会话；每次会话记录了用户发送给 Aily 助手的消息以及 Aily 助手的响应。 +/// - **消息**（Message）：消息可以包含文本、表格、图片等多种类型的内容。 +/// - **运行**（Run）：Aily 助手基于会话内消息进行意图判定、调用匹配的技能，并返回技能执行后的结果消息。 /// 接口ID：7358047310868185092 /// 文档地址：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session-run/create /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2faily-v1%2faily_session-run%2fcreate @@ -22,9 +26,9 @@ namespace FeishuNetSdk.Aily; public record PostAilyV1SessionsByAilySessionIdRunsBodyDto { /// - /// 应用 ID + /// 为 Aily 应用 ID（`spring_xxx__c`），可以在 Aily 应用开发页面的浏览器地址里获取 /// 必填：是 - /// 示例值：spring_xxx__c + /// 示例值：spring_449d72db2f__c /// 最大长度：64 /// 最小长度：0 /// @@ -32,7 +36,8 @@ public record PostAilyV1SessionsByAilySessionIdRunsBodyDto public string AppId { get; set; } = string.Empty; /// - /// 技能 ID + /// 指定技能 ID（`skill_xxx`），可以在 Aily 技能配置页面的浏览器地址里获取 + /// > 指定技能后、能够节省意图匹配的耗时 /// 必填：否 /// 示例值：skill_6cc6166178ca /// 最大长度：32 @@ -43,8 +48,9 @@ public record PostAilyV1SessionsByAilySessionIdRunsBodyDto /// /// 指定技能 ID 时可以同时指定技能输入 + /// > 备注：常用于工作流技能内指定自定义参数，`skill_input` 需要配合 `skill_id` 同时传递才能生效 /// 必填：否 - /// 示例值：{"key": "value"} + /// 示例值：{\"key\": \"value\"} /// 最大长度：255 /// 最小长度：0 /// @@ -52,7 +58,8 @@ public record PostAilyV1SessionsByAilySessionIdRunsBodyDto public string? SkillInput { get; set; } /// - /// 其他透传信息 + /// 其他扩展的参数（JSON String） + /// > 备注：`metadata` 传递的参数，可以在后续 `GetRun` 调用中原样读取获得 /// 必填：否 /// 示例值：{} /// 最大长度：255 diff --git a/src/Aily/PostAilyV1SessionsByAilySessionIdRunsByRunIdCancelResponseDto.cs b/src/Aily/PostAilyV1SessionsByAilySessionIdRunsByRunIdCancelResponseDto.cs index 4e5af1f8..528d936e 100644 --- a/src/Aily/PostAilyV1SessionsByAilySessionIdRunsByRunIdCancelResponseDto.cs +++ b/src/Aily/PostAilyV1SessionsByAilySessionIdRunsByRunIdCancelResponseDto.cs @@ -14,7 +14,11 @@ namespace FeishuNetSdk.Aily; /// /// 取消运行 响应体 -/// 该 API 用于取消某个飞书智能伙伴应用的运行（Run）。 +/// 该 API 用于中止某个飞书智能伙伴的一次运行。 +/// ## 实体概念说明 +/// - **会话**（Session）：管理用户与 Aily 助手之间的交互会话；每次会话记录了用户发送给 Aily 助手的消息以及 Aily 助手的响应。 +/// - **消息**（Message）：消息可以包含文本、表格、图片等多种类型的内容。 +/// - **运行**（Run）：Aily 助手基于会话内消息进行意图判定、调用匹配的技能，并返回技能执行后的结果消息。 /// 接口ID：7358047310868217860 /// 文档地址：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session-run/cancel /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2faily-v1%2faily_session-run%2fcancel @@ -74,7 +78,8 @@ public record PostAilyV1SessionsByAilySessionIdRunsByRunIdCancelResponseDtoRun public string SessionId { get; set; } = string.Empty; /// - /// 状态 + /// 运行状态；详见 [Run 状态机说明](https://bytedance.larkoffice.com/wiki/UTU6wVTVGigefykjO1acAOOvnNc#part-LGZrdJTUFo5c8XxSpYXcm3oknEd) + /// > 如中止已在终态（如 `COMPLETED`）的 `Run`，不会改变 `Run` 的状态 /// 必填：是 /// 示例值：IN_PROGRESS /// diff --git a/src/Aily/PostAilyV1SessionsByAilySessionIdRunsResponseDto.cs b/src/Aily/PostAilyV1SessionsByAilySessionIdRunsResponseDto.cs index c68d4630..cec1c918 100644 --- a/src/Aily/PostAilyV1SessionsByAilySessionIdRunsResponseDto.cs +++ b/src/Aily/PostAilyV1SessionsByAilySessionIdRunsResponseDto.cs @@ -15,6 +15,10 @@ namespace FeishuNetSdk.Aily; /// /// 创建运行 响应体 /// 该 API 用于在某个飞书智能伙伴应用会话（Session）上创建一次运行（Run）。 +/// ## 实体概念说明 +/// - **会话**（Session）：管理用户与 Aily 助手之间的交互会话；每次会话记录了用户发送给 Aily 助手的消息以及 Aily 助手的响应。 +/// - **消息**（Message）：消息可以包含文本、表格、图片等多种类型的内容。 +/// - **运行**（Run）：Aily 助手基于会话内消息进行意图判定、调用匹配的技能，并返回技能执行后的结果消息。 /// 接口ID：7358047310868185092 /// 文档地址：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session-run/create /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2faily-v1%2faily_session-run%2fcreate diff --git a/src/Aily/PostAilyV1SessionsResponseDto.cs b/src/Aily/PostAilyV1SessionsResponseDto.cs index 9c8f8eed..f0a7019b 100644 --- a/src/Aily/PostAilyV1SessionsResponseDto.cs +++ b/src/Aily/PostAilyV1SessionsResponseDto.cs @@ -14,7 +14,11 @@ namespace FeishuNetSdk.Aily; /// /// 创建会话 响应体 -/// 该 API 用于创建与某个飞书智能伙伴应用的一次会话（Session）；当创建会话成功后，可以发送消息、创建运行 +/// 该 API 用于创建与某个飞书智能伙伴应用的一次会话（Session）；当创建会话成功后，可以发送消息、创建运行。 +/// ## 实体概念说明 +/// - **会话**（Session）：管理用户与 Aily 助手之间的交互会话；每次会话记录了用户发送给 Aily 助手的消息以及 Aily 助手的响应。 +/// - **消息**（Message）：消息可以包含文本、表格、图片等多种类型的内容。 +/// - **运行**（Run）：Aily 助手基于会话内消息进行意图判定、调用匹配的技能，并返回技能执行后的结果消息。 /// 接口ID：7358047310868316164 /// 文档地址：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session/create /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2faily-v1%2faily_session%2fcreate @@ -64,7 +68,7 @@ public record AilySession public string ModifiedAt { get; set; } = string.Empty; /// - /// 会话的创建人 + /// 会话的创建人（Aily UserID） /// 必填：是 /// 示例值：1794840334557292 /// 最大长度：20 @@ -74,7 +78,7 @@ public record AilySession public string CreatedBy { get; set; } = string.Empty; /// - /// 渠道上下文 + /// 可自行构造的 Context [上下文变量](https://aily.feishu.cn/hc/1u7kleqg/en70bqqj#6a446d5e)；在 Workflow 技能中可消费这部分全局变量 /// 必填：否 /// 示例值：{} /// 最大长度：255 @@ -84,7 +88,7 @@ public record AilySession public string? ChannelContext { get; set; } /// - /// 其他透传信息 + /// 会话的自定义变量内容，变量数据保存在服务端 Session 中，可在 `GetSession` 时原样返回，无需在 API 调用侧存储 /// 必填：否 /// 示例值：{} /// 最大长度：255 diff --git a/src/Aily/PutAilyV1SessionsByAilySessionIdBodyDto.cs b/src/Aily/PutAilyV1SessionsByAilySessionIdBodyDto.cs index c1a43301..12f569eb 100644 --- a/src/Aily/PutAilyV1SessionsByAilySessionIdBodyDto.cs +++ b/src/Aily/PutAilyV1SessionsByAilySessionIdBodyDto.cs @@ -22,7 +22,7 @@ namespace FeishuNetSdk.Aily; public record PutAilyV1SessionsByAilySessionIdBodyDto { /// - /// 渠道上下文 + /// 可自行构造的 Context [上下文变量](https://aily.feishu.cn/hc/1u7kleqg/en70bqqj#6a446d5e)；在 Workflow 技能中可消费这部分全局变量 /// 必填：否 /// 示例值：{} /// 最大长度：255 @@ -32,7 +32,7 @@ public record PutAilyV1SessionsByAilySessionIdBodyDto public string? ChannelContext { get; set; } /// - /// 其他透传信息 + /// 会话的自定义变量内容，变量数据保存在服务端 Session 中，可在 `GetSession` 时原样返回，无需在 API 调用侧存储 /// 必填：否 /// 示例值：{} /// 最大长度：255 diff --git a/src/Aily/PutAilyV1SessionsByAilySessionIdResponseDto.cs b/src/Aily/PutAilyV1SessionsByAilySessionIdResponseDto.cs index 29e4f1c8..bd5b0799 100644 --- a/src/Aily/PutAilyV1SessionsByAilySessionIdResponseDto.cs +++ b/src/Aily/PutAilyV1SessionsByAilySessionIdResponseDto.cs @@ -64,7 +64,7 @@ public record AilySession public string ModifiedAt { get; set; } = string.Empty; /// - /// 会话的创建人 + /// 会话的创建人（Aily UserID） /// 必填：是 /// 示例值：1794840334557292 /// 最大长度：20 @@ -74,7 +74,7 @@ public record AilySession public string CreatedBy { get; set; } = string.Empty; /// - /// 渠道上下文 + /// 可自行构造的 Context [上下文变量](https://aily.feishu.cn/hc/1u7kleqg/en70bqqj#6a446d5e)；在 Workflow 技能中可消费这部分全局变量 /// 必填：否 /// 示例值：{} /// 最大长度：255 @@ -84,7 +84,7 @@ public record AilySession public string? ChannelContext { get; set; } /// - /// 其他透传信息 + /// 会话的自定义变量内容，变量数据保存在服务端 Session 中，可在 `GetSession` 时原样返回，无需在 API 调用侧存储 /// 必填：否 /// 示例值：{} /// 最大长度：255 diff --git a/src/Base/GetBitableV1AppsByAppTokenResponseDto.cs b/src/Base/GetBitableV1AppsByAppTokenResponseDto.cs index 7aa3a985..a39007df 100644 --- a/src/Base/GetBitableV1AppsByAppTokenResponseDto.cs +++ b/src/Base/GetBitableV1AppsByAppTokenResponseDto.cs @@ -14,9 +14,7 @@ namespace FeishuNetSdk.Base; /// /// 获取多维表格元数据 响应体 -/// 获取指定多维表格的元数据信息，包括多维表格名称，多维表格版本号，多维表格是否开启高级权限等。 -/// note -/// 首次调用请参考 [云文档接口快速入门](https://open.feishu.cn/document/ukTMukTMukTM/uczNzUjL3czM14yN3MTN)[多维表格接口接入指南](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bitable/notification) +/// 获取指定多维表格的元数据信息，包括多维表格名称、多维表格版本号、多维表格是否开启高级权限等。 /// 接口ID：6960166873968574467 /// 文档地址：https://open.feishu.cn/document/server-docs/docs/bitable-v1/app/get /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fbitable-v1%2fapp%2fget @@ -36,8 +34,7 @@ public record GetBitableV1AppsByAppTokenResponseDto public record DisplayApp { /// - /// 多维表格的 app_token - /// [app_token 参数说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bitable/notification#8121eebe) + /// 多维表格的唯一标识 app_token /// 必填：否 /// 示例值：\- /// @@ -45,7 +42,7 @@ public record DisplayApp public string? AppToken { get; set; } /// - /// 多维表格的名字 + /// 多维表格的名称 /// 必填：否 /// 示例值：\- /// @@ -53,7 +50,7 @@ public record DisplayApp public string? Name { get; set; } /// - /// 多维表格的版本号（对多维表格进行修改时更新，如新增、删除数据表，修改数据表名等，初始为1，每次更新+1） + /// 多维表格的版本号。对多维表格进行修改时更新，如新增、删除数据表，修改数据表名等，初始为 1，每次更新+1 /// 必填：否 /// 示例值：\- /// @@ -62,9 +59,9 @@ public record DisplayApp /// /// 多维表格是否开启了高级权限。取值包括： - /// - true：表示开启了高级权限 - /// - false：表示关闭了高级权限 - /// [了解更多：使用多维表格高级权限](https://www.feishu.cn/hc/zh-CN/articles/588604550568) + /// - true：开启了高级权限 + /// - false：关闭了高级权限 + /// 了解更多参考飞书帮助中心文档[使用多维表格高级权限](https://www.feishu.cn/hc/zh-CN/articles/588604550568)。 /// 必填：否 /// 示例值：\- /// diff --git a/src/Base/PostBitableV1AppsBodyDto.cs b/src/Base/PostBitableV1AppsBodyDto.cs index 2db9a049..05abf0b4 100644 --- a/src/Base/PostBitableV1AppsBodyDto.cs +++ b/src/Base/PostBitableV1AppsBodyDto.cs @@ -14,7 +14,7 @@ namespace FeishuNetSdk.Base; /// /// 创建多维表格 请求体 -/// 在指定目录下创建多维表格 +/// 在指定文件夹中创建一个多维表格，包含一个空白的数据表。 /// 接口ID：7047733935745007620 /// 文档地址：https://open.feishu.cn/document/server-docs/docs/bitable-v1/app/create /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fbitable-v1%2fapp%2fcreate @@ -22,7 +22,7 @@ namespace FeishuNetSdk.Base; public record PostBitableV1AppsBodyDto { /// - /// 多维表格App名字 + /// 多维表格 App 名称 /// 必填：否 /// 示例值：一篇新的多维表格 /// @@ -30,17 +30,17 @@ public record PostBitableV1AppsBodyDto public string? Name { get; set; } /// - /// 多维表格App归属文件夹。默认为空，表示多维表格将被创建在云空间根目录。关于如何获取 folder_token，可参见[如何获取云文档资源相关 token](https://open.feishu.cn/document/server-docs/docs/faq#08bb5df6) + /// 多维表格 App 归属文件夹。默认为空，表示多维表格将被创建在云空间根目录。了解如何获取文件夹 Token，参考[如何获取云文档资源相关 Token](https://open.feishu.cn/document/ukTMukTMukTM/uczNzUjL3czM14yN3MTN#08bb5df6)。 /// **注意**： - /// 请确保调用身份拥有在该文件夹中的编辑权限。详情参考[如何为应用开通云文档相关资源的权限](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-add-permissions-to-app)。 + /// 请确保调用身份拥有在该文件夹中的编辑权限。若应用使用的是 `tenant_access_token` 权限，此处仅可指定应用创建的文件夹。详情参考[如何为应用开通云文档相关资源的权限](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-add-permissions-to-app)。 /// 必填：否 - /// 示例值：fldbco*****CIMltVc + /// 示例值：fldcnqquW1svRIYVT2Np6Iabcef /// [JsonPropertyName("folder_token")] public string? FolderToken { get; set; } /// - /// 文档时区，[详见](https://feishu.feishu.cn/docx/YKRndTM7VoyDqpxqqeEcd67MnEf) + /// 文档时区，详情参考[文档时区介绍](https://feishu.feishu.cn/docx/YKRndTM7VoyDqpxqqeEcd67MnEf)。 /// 必填：否 /// 示例值：Asia/Macau /// diff --git a/src/Base/PostBitableV1AppsByAppTokenCopyBodyDto.cs b/src/Base/PostBitableV1AppsByAppTokenCopyBodyDto.cs index 989868ec..8798a48b 100644 --- a/src/Base/PostBitableV1AppsByAppTokenCopyBodyDto.cs +++ b/src/Base/PostBitableV1AppsByAppTokenCopyBodyDto.cs @@ -15,6 +15,8 @@ namespace FeishuNetSdk.Base; /// /// 复制多维表格 请求体 /// 复制一个多维表格，可以指定复制到某个有权限的文件夹下。 +/// ## 前提条件 +/// 调用此接口前，请确保当前调用身份（tenant_access_token 或 user_access_token）已有多维表格和目标文件夹的阅读、编辑等文档权限，否则接口将返回 HTTP 403 或 400 状态码。了解更多，参考[如何为应用或用户开通云文档权限](https://open.feishu.cn/document/ukTMukTMukTM/uczNzUjL3czM14yN3MTN#16c6475a)。 /// 接口ID：7205776220394160156 /// 文档地址：https://open.feishu.cn/document/server-docs/docs/bitable-v1/app/copy /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fbitable-v1%2fapp%2fcopy @@ -22,7 +24,7 @@ namespace FeishuNetSdk.Base; public record PostBitableV1AppsByAppTokenCopyBodyDto { /// - /// 多维表格 App 名字 + /// 多维表格 App 的名称 /// 必填：否 /// 示例值：一篇新的多维表格 /// @@ -30,15 +32,17 @@ public record PostBitableV1AppsByAppTokenCopyBodyDto public string? Name { get; set; } /// - /// [多维表格 App 归属文件夹 ](https://open.feishu.cn/document/ukTMukTMukTM/uczNzUjL3czM14yN3MTN#08bb5df) + /// 了解如何获取文件夹 Token，参考[如何获取云文档资源相关 Token](https://open.feishu.cn/document/ukTMukTMukTM/uczNzUjL3czM14yN3MTN#08bb5df6)。 + /// **注意**： + /// 请确保调用身份拥有在该文件夹中的编辑权限。若应用使用的是 `tenant_access_token` 权限，此处仅可指定应用创建的文件夹。详情参考[如何为应用开通云文档相关资源的权限](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-add-permissions-to-app)。 /// 必填：否 - /// 示例值：fldbco*****CIMltVc + /// 示例值：fldcnqquW1svRIYVT2Np6Iabcef /// [JsonPropertyName("folder_token")] public string? FolderToken { get; set; } /// - /// 是否复制多维表格内容，取值： + /// 是否复制多维表格中的内容，默认 false，即复制多维表格中的内容。可取值： /// * true：不复制 /// * false：复制 /// 必填：否 @@ -48,7 +52,7 @@ public record PostBitableV1AppsByAppTokenCopyBodyDto public bool? WithoutContent { get; set; } /// - /// 文档时区，[详见](https://feishu.feishu.cn/docx/YKRndTM7VoyDqpxqqeEcd67MnEf) + /// 文档时区，详情参考[文档时区介绍](https://feishu.feishu.cn/docx/YKRndTM7VoyDqpxqqeEcd67MnEf)。 /// 必填：否 /// 示例值：Asia/Shanghai /// diff --git a/src/Base/PostBitableV1AppsByAppTokenCopyResponseDto.cs b/src/Base/PostBitableV1AppsByAppTokenCopyResponseDto.cs index 178cbf45..b19282be 100644 --- a/src/Base/PostBitableV1AppsByAppTokenCopyResponseDto.cs +++ b/src/Base/PostBitableV1AppsByAppTokenCopyResponseDto.cs @@ -15,6 +15,8 @@ namespace FeishuNetSdk.Base; /// /// 复制多维表格 响应体 /// 复制一个多维表格，可以指定复制到某个有权限的文件夹下。 +/// ## 前提条件 +/// 调用此接口前，请确保当前调用身份（tenant_access_token 或 user_access_token）已有多维表格和目标文件夹的阅读、编辑等文档权限，否则接口将返回 HTTP 403 或 400 状态码。了解更多，参考[如何为应用或用户开通云文档权限](https://open.feishu.cn/document/ukTMukTMukTM/uczNzUjL3czM14yN3MTN#16c6475a)。 /// 接口ID：7205776220394160156 /// 文档地址：https://open.feishu.cn/document/server-docs/docs/bitable-v1/app/copy /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fbitable-v1%2fapp%2fcopy @@ -34,7 +36,7 @@ public record PostBitableV1AppsByAppTokenCopyResponseDto public record PostBitableV1AppsByAppTokenCopyResponseDtoApp { /// - /// 多维表格的 app_token + /// 多维表格的唯一标识 app_token /// 必填：否 /// 示例值：S404b*****e9PQsYDWYcNryFn0g /// @@ -42,7 +44,7 @@ public record PostBitableV1AppsByAppTokenCopyResponseDtoApp public string? AppToken { get; set; } /// - /// 多维表格的名字 + /// 多维表格的名称 /// 必填：否 /// 示例值：一篇新的多维表格 /// @@ -58,7 +60,7 @@ public record PostBitableV1AppsByAppTokenCopyResponseDtoApp public string? FolderToken { get; set; } /// - /// 多维表格 App URL + /// 多维表格 App 的 URL 链接 /// 必填：否 /// 示例值：https://example.feishu.cn/base/S404b*****e9PQsYDWYcNryFn0g /// diff --git a/src/Base/PostBitableV1AppsByAppTokenTablesBatchDeleteBodyDto.cs b/src/Base/PostBitableV1AppsByAppTokenTablesBatchDeleteBodyDto.cs index f65a05c9..3afee960 100644 --- a/src/Base/PostBitableV1AppsByAppTokenTablesBatchDeleteBodyDto.cs +++ b/src/Base/PostBitableV1AppsByAppTokenTablesBatchDeleteBodyDto.cs @@ -24,7 +24,11 @@ namespace FeishuNetSdk.Base; public record PostBitableV1AppsByAppTokenTablesBatchDeleteBodyDto { /// - /// 待删除的数据表的id [table_id 参数说明]，当前一次操作最多支持50个数据表(https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bitable/notification#735fe883) + /// 待删除的数据表的 ID。当前一次操作最多支持50个数据表。 + /// 获取方式： + /// - 你可通过多维表格 URL 获取 `table_id`，下图高亮部分即为当前数据表的 `table_id`。 + /// - 也可通过[列出数据表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/list)接口获取 `table_id`。 + /// ![](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/18741fe2a0d3cafafaf9949b263bb57d_yD1wkOrSju.png?height=746&lazyload=true&maxWidth=700&width=2976) /// 必填：否 /// 示例值：["tblsRc9GRRXKqhvW"] /// diff --git a/src/Base/PostBitableV1AppsByAppTokenTablesBodyDto.cs b/src/Base/PostBitableV1AppsByAppTokenTablesBodyDto.cs index e1911424..25c5d60f 100644 --- a/src/Base/PostBitableV1AppsByAppTokenTablesBodyDto.cs +++ b/src/Base/PostBitableV1AppsByAppTokenTablesBodyDto.cs @@ -14,9 +14,7 @@ namespace FeishuNetSdk.Base; /// /// 新增一个数据表 请求体 -/// 通过该接口，可以新增一个仅包含索引列的空数据表，也可以指定一部分初始字段。 -/// note -/// 首次调用请参考 [云文档接口快速入门](https://open.feishu.cn/document/ukTMukTMukTM/uczNzUjL3czM14yN3MTN)[多维表格接口接入指南](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bitable/notification) +/// 新增一个数据表，默认仅包含索引列，也可以指定一部分初始字段。 /// 接口ID：6960166873968541699 /// 文档地址：https://open.feishu.cn/document/server-docs/docs/bitable-v1/app-table/create /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fbitable-v1%2fapp-table%2fcreate @@ -36,11 +34,9 @@ public record PostBitableV1AppsByAppTokenTablesBodyDto public record ReqTable { /// - /// 数据表名称 - /// 请注意： - /// 1. 名称中的首尾空格将会被去除。 + /// 数据表名称。名称中的首尾空格将会被默认去除。 /// 必填：否 - /// 示例值：table1 + /// 示例值：一个新的数据表 /// 最大长度：100 /// 最小长度：1 /// @@ -48,21 +44,21 @@ public record ReqTable public string? Name { get; set; } /// - /// 默认表格视图的名称，不填则默认为 表格。 - /// 请注意： - /// 1. 名称中的首尾空格将会被去除。 - /// 2. 名称中不允许包含 [ ] 两个字符 + /// 默认表格视图的名称，不填则默认为“表格视图 1”。 + /// 注意： + /// - 名称中的首尾空格将会被去除。 + /// - 名称中不允许包含 [ ] 两个字符 /// 必填：否 - /// 示例值：表格 + /// 示例值：表格视图 /// [JsonPropertyName("default_view_name")] public string? DefaultViewName { get; set; } /// /// 数据表的初始字段。 - /// 请注意： - /// 1. 如果 default_view_name 字段和 fields 字段都不填写，将会创建一个仅包含索引列的空数据表。 - /// 2. 如果指定了 fields 字段，将会创建一个包含初始字段的数据表且默认第一个字段为索引列。 + /// 注意： + /// - 如果 default_view_name 字段和 fields 字段都不填写，将会创建一个仅包含索引列的空数据表。 + /// - 如果指定了本字段，将会创建一个包含初始字段的数据表、且默认第一个字段为索引列。 /// 必填：否 /// 最大长度：300 /// 最小长度：1 @@ -72,14 +68,14 @@ public record ReqTable /// /// 数据表的初始字段。 - /// 请注意： - /// 1. 如果 default_view_name 字段和 fields 字段都不填写，将会创建一个仅包含索引列的空数据表。 - /// 2. 如果指定了 fields 字段，将会创建一个包含初始字段的数据表且默认第一个字段为索引列。 + /// 注意： + /// - 如果 default_view_name 字段和 fields 字段都不填写，将会创建一个仅包含索引列的空数据表。 + /// - 如果指定了本字段，将会创建一个包含初始字段的数据表、且默认第一个字段为索引列。 /// public record AppTableCreateHeader { /// - /// 字段名 + /// 字段名称 /// 必填：是 /// 示例值：文本 /// @@ -91,7 +87,7 @@ public record AppTableCreateHeader /// 必填：是 /// 示例值：1 /// 可选值： - /// 1：多行文本 + /// 1：文本 /// 2：数字 /// 3：单选 /// 4：多选 diff --git a/src/Base/PostBitableV1AppsByAppTokenTablesByTableIdRecordsBodyDto.cs b/src/Base/PostBitableV1AppsByAppTokenTablesByTableIdRecordsBodyDto.cs index af4109a8..713a7f3e 100644 --- a/src/Base/PostBitableV1AppsByAppTokenTablesByTableIdRecordsBodyDto.cs +++ b/src/Base/PostBitableV1AppsByAppTokenTablesByTableIdRecordsBodyDto.cs @@ -15,8 +15,6 @@ namespace FeishuNetSdk.Base; /// /// 新增记录 请求体 /// 该接口用于在数据表中新增一条记录 -/// note -/// 首次调用请参考 [云文档接口快速入门](https://open.feishu.cn/document/ukTMukTMukTM/uczNzUjL3czM14yN3MTN)[多维表格接口接入指南](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bitable/notification) /// 接口ID：6952707657162522626 /// 文档地址：https://open.feishu.cn/document/server-docs/docs/bitable-v1/app-table-record/create /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fbitable-v1%2fapp-table-record%2fcreate diff --git a/src/Base/PostBitableV1AppsByAppTokenTablesByTableIdRecordsResponseDto.cs b/src/Base/PostBitableV1AppsByAppTokenTablesByTableIdRecordsResponseDto.cs index 5fcd20ad..16c9daac 100644 --- a/src/Base/PostBitableV1AppsByAppTokenTablesByTableIdRecordsResponseDto.cs +++ b/src/Base/PostBitableV1AppsByAppTokenTablesByTableIdRecordsResponseDto.cs @@ -15,8 +15,6 @@ namespace FeishuNetSdk.Base; /// /// 新增记录 响应体 /// 该接口用于在数据表中新增一条记录 -/// note -/// 首次调用请参考 [云文档接口快速入门](https://open.feishu.cn/document/ukTMukTMukTM/uczNzUjL3czM14yN3MTN)[多维表格接口接入指南](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bitable/notification) /// 接口ID：6952707657162522626 /// 文档地址：https://open.feishu.cn/document/server-docs/docs/bitable-v1/app-table-record/create /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fbitable-v1%2fapp-table-record%2fcreate diff --git a/src/Base/PostBitableV1AppsByAppTokenTablesResponseDto.cs b/src/Base/PostBitableV1AppsByAppTokenTablesResponseDto.cs index d10aa5f1..58d2fe43 100644 --- a/src/Base/PostBitableV1AppsByAppTokenTablesResponseDto.cs +++ b/src/Base/PostBitableV1AppsByAppTokenTablesResponseDto.cs @@ -14,9 +14,7 @@ namespace FeishuNetSdk.Base; /// /// 新增一个数据表 响应体 -/// 通过该接口，可以新增一个仅包含索引列的空数据表，也可以指定一部分初始字段。 -/// note -/// 首次调用请参考 [云文档接口快速入门](https://open.feishu.cn/document/ukTMukTMukTM/uczNzUjL3czM14yN3MTN)[多维表格接口接入指南](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bitable/notification) +/// 新增一个数据表，默认仅包含索引列，也可以指定一部分初始字段。 /// 接口ID：6960166873968541699 /// 文档地址：https://open.feishu.cn/document/server-docs/docs/bitable-v1/app-table/create /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fbitable-v1%2fapp-table%2fcreate diff --git a/src/Base/PostBitableV1AppsResponseDto.cs b/src/Base/PostBitableV1AppsResponseDto.cs index 3985aea5..5e95857a 100644 --- a/src/Base/PostBitableV1AppsResponseDto.cs +++ b/src/Base/PostBitableV1AppsResponseDto.cs @@ -14,7 +14,7 @@ namespace FeishuNetSdk.Base; /// /// 创建多维表格 响应体 -/// 在指定目录下创建多维表格 +/// 在指定文件夹中创建一个多维表格，包含一个空白的数据表。 /// 接口ID：7047733935745007620 /// 文档地址：https://open.feishu.cn/document/server-docs/docs/bitable-v1/app/create /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fbitable-v1%2fapp%2fcreate @@ -34,7 +34,7 @@ public record PostBitableV1AppsResponseDto public record PostBitableV1AppsResponseDtoApp { /// - /// 多维表格的 app_token + /// 多维表格的唯一标识 app_token /// 必填：否 /// 示例值：\- /// @@ -42,7 +42,7 @@ public record PostBitableV1AppsResponseDtoApp public string? AppToken { get; set; } /// - /// 多维表格的名字 + /// 多维表格的名称 /// 必填：否 /// 示例值：\- /// @@ -58,7 +58,7 @@ public record PostBitableV1AppsResponseDtoApp public string? FolderToken { get; set; } /// - /// 多维表格 App URL + /// 多维表格 App 的 URL 链接 /// 必填：否 /// 示例值：\- /// @@ -66,9 +66,9 @@ public record PostBitableV1AppsResponseDtoApp public string? Url { get; set; } /// - /// 默认的表格id + /// 默认创建的数据表 ID /// 必填：否 - /// 示例值：tblxxxxxxxxoumSQ + /// 示例值：tblEtaUgtZIabcef /// [JsonPropertyName("default_table_id")] public string? DefaultTableId { get; set; } diff --git a/src/Base/PutBitableV1AppsByAppTokenBodyDto.cs b/src/Base/PutBitableV1AppsByAppTokenBodyDto.cs index 875b81ab..4f4fc267 100644 --- a/src/Base/PutBitableV1AppsByAppTokenBodyDto.cs +++ b/src/Base/PutBitableV1AppsByAppTokenBodyDto.cs @@ -14,7 +14,10 @@ namespace FeishuNetSdk.Base; /// /// 更新多维表格元数据 请求体 -/// 通过 app_token 更新多维表格元数据 +/// 更新多维表格元数据，包括多维表格的名称、是否开启高级权限。 +/// ## 注意事项 +/// - 在线文档和电子表格中嵌入的多维表格、知识库中的多维表格不支持开启高级权限。 +/// - 此接口非原子操作，先修改多维表格名称，后开关高级权限，可能存在部分成功的情况。 /// 接口ID：7073673019918811164 /// 文档地址：https://open.feishu.cn/document/server-docs/docs/bitable-v1/app/update /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fbitable-v1%2fapp%2fupdate @@ -22,15 +25,17 @@ namespace FeishuNetSdk.Base; public record PutBitableV1AppsByAppTokenBodyDto { /// - /// 新的多维表格名字 + /// 新的多维表格名称，不传则不更新名称。 /// 必填：否 - /// 示例值：新的多维表格名字 + /// 示例值：新的多维表格名称 /// [JsonPropertyName("name")] public string? Name { get; set; } /// - /// 多维表格是否开启高级权限 + /// 多维表格是否开启高级权限。不传则不更新设置。可选值： + /// - true：开启高级权限 + /// - false：关闭高级权限 /// 必填：否 /// 示例值：true /// diff --git a/src/Base/PutBitableV1AppsByAppTokenResponseDto.cs b/src/Base/PutBitableV1AppsByAppTokenResponseDto.cs index 770c8d2e..14104760 100644 --- a/src/Base/PutBitableV1AppsByAppTokenResponseDto.cs +++ b/src/Base/PutBitableV1AppsByAppTokenResponseDto.cs @@ -14,7 +14,10 @@ namespace FeishuNetSdk.Base; /// /// 更新多维表格元数据 响应体 -/// 通过 app_token 更新多维表格元数据 +/// 更新多维表格元数据，包括多维表格的名称、是否开启高级权限。 +/// ## 注意事项 +/// - 在线文档和电子表格中嵌入的多维表格、知识库中的多维表格不支持开启高级权限。 +/// - 此接口非原子操作，先修改多维表格名称，后开关高级权限，可能存在部分成功的情况。 /// 接口ID：7073673019918811164 /// 文档地址：https://open.feishu.cn/document/server-docs/docs/bitable-v1/app/update /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fbitable-v1%2fapp%2fupdate @@ -34,7 +37,7 @@ public record PutBitableV1AppsByAppTokenResponseDto public record DisplayAppV2 { /// - /// 多维表格的 app_token + /// 多维表格的唯一标识 app_token /// 必填：否 /// 示例值：S404b*****e9PQsYDWYcNryFn0g /// @@ -42,9 +45,9 @@ public record DisplayAppV2 public string? AppToken { get; set; } /// - /// 多维表格的名字 + /// 多维表格的名称 /// 必填：否 - /// 示例值：appname + /// 示例值：app name /// [JsonPropertyName("name")] public string? Name { get; set; } diff --git a/src/Base/PutBitableV1AppsByAppTokenTablesByTableIdRecordsByRecordIdResponseDto.cs b/src/Base/PutBitableV1AppsByAppTokenTablesByTableIdRecordsByRecordIdResponseDto.cs index 56cdcb44..81c209f8 100644 --- a/src/Base/PutBitableV1AppsByAppTokenTablesByTableIdRecordsByRecordIdResponseDto.cs +++ b/src/Base/PutBitableV1AppsByAppTokenTablesByTableIdRecordsByRecordIdResponseDto.cs @@ -46,7 +46,7 @@ public record AppTableRecord public object Fields { get; set; } = new(); /// - /// 一条记录的唯一标识 id [record_id 参数说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bitable/notification#15d8db94) + /// 数据表中一条记录的唯一标识 /// 必填：否 /// 示例值：\- /// diff --git a/src/Contact.Events/ContactUserUpdatedV3EventBodyDto.cs b/src/Contact.Events/ContactUserUpdatedV3EventBodyDto.cs index 63f60e28..b20a0ea7 100644 --- a/src/Contact.Events/ContactUserUpdatedV3EventBodyDto.cs +++ b/src/Contact.Events/ContactUserUpdatedV3EventBodyDto.cs @@ -4,7 +4,7 @@ // Created : 2024-09-01 // // Last Modified By : yxr -// Last Modified On : 2024-09-01 +// Last Modified On : 2024-10-18 // ************************************************************************ // // MIT @@ -14,7 +14,7 @@ namespace FeishuNetSdk.Contact.Events; /// /// 员工信息被修改 事件体 -/// 当应用订阅该事件后，当员工信息被修改时将会触发该事件。你可以在事件的 old_object 字段中查看修改前的用户信息；在事件的 object 字段中可以查看修改后的用户信息。{使用示例}(url=/api/tools/api_explore/api_explore_config?project=contact&version=v3&resource=user&event=updated) +/// 应用订阅该事件后，当员工信息（包括：ID、用户名、英文名、别名、邮箱、企业邮箱、职务、手机号、性别、头像、状态、所属部门、直属主管、城市、国家、工位、入职时间、工号、类型、排序、自定义字段、职级、序列、虚线上级）被修改时将会触发该事件。你可以在事件的 old_object 字段中查看修改前的用户信息；在事件的 object 字段中可以查看修改后的用户信息。{使用示例}(url=/api/tools/api_explore/api_explore_config?project=contact&version=v3&resource=user&event=updated) /// 接口ID：6954228303264055323 /// 文档地址：https://open.feishu.cn/document/server-docs/contact-v3/user/events/updated /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fcontact-v3%2fuser%2fevents%2fupdated @@ -28,6 +28,13 @@ public record ContactUserUpdatedV3EventBodyDto() : EventBodyDto("contact.user.up [JsonPropertyName("object")] public UserEvent? Object { get; set; } + /// + /// 变更前的用户信息，只包含有变更的字段数据。 + /// 必填：否 + /// + [JsonPropertyName("old_object")] + public UserEvent? OldObject { get; set; } + /// /// 员工信息 /// @@ -103,18 +110,6 @@ public record UserEvent [JsonPropertyName("email")] public string? Email { get; set; } - /// - /// 企业邮箱。 - /// **字段权限要求（满足任一）**： - /// - contact:contact:readonly_as_app : 以应用身份读取通讯录 - /// - contact:user.base:readonly : 获取用户基本信息 - /// - contact:contact:access_as_app : 以应用身份访问通讯录 - /// - contact:contact:readonly : 读取通讯录 - /// 必填：否 - /// - [JsonPropertyName("enterprise_email")] - public string? EnterpriseEmail { get; set; } - /// /// 职务。 /// 必填：否 diff --git a/src/Core/EventDto.cs b/src/Core/EventDto.cs index e003ce15..272a8873 100644 --- a/src/Core/EventDto.cs +++ b/src/Core/EventDto.cs @@ -4,7 +4,7 @@ // Created : 2024-09-01 // // Last Modified By : yxr -// Last Modified On : 2024-10-12 +// Last Modified On : 2024-10-19 // ************************************************************************ // // MIT @@ -346,6 +346,8 @@ namespace FeishuNetSdk.Core; [JsonDerivedType(typeof(EventV2Dto), typeDiscriminator: "hire.ehr_import_task_for_internship_offer.imported_v1")] //【招聘】内推账户余额变更 [JsonDerivedType(typeof(EventV2Dto), typeDiscriminator: "hire.referral_account.assets_update_v1")] +//【招聘】人才进展变更事件 +[JsonDerivedType(typeof(EventV2Dto), typeDiscriminator: "hire.talent.tag_subscription_v1")] //【招聘】删除人才 [JsonDerivedType(typeof(EventV2Dto), typeDiscriminator: "hire.talent.deleted_v1")] //【招聘】删除投递 diff --git a/src/Corehr/GetCorehrV2ApproversResponseDto.cs b/src/Corehr/GetCorehrV2ApproversResponseDto.cs index 28be7d29..1a075344 100644 --- a/src/Corehr/GetCorehrV2ApproversResponseDto.cs +++ b/src/Corehr/GetCorehrV2ApproversResponseDto.cs @@ -15,9 +15,9 @@ namespace FeishuNetSdk.Corehr; /// /// 获取指定人员审批任务列表 响应体 /// 审批任务依赖于流程节点实例存在，每一个流程节点实例可能包含有一或多个审批任务，每一个任务表明当前节点的审批人是谁，该接口可获取指定人员的审批任务列表。 -/// 接口ID：7419213540896423940 -/// 文档地址：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/process_approver/list -/// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2fcorehr-v2%2fprocess_approver%2flist +/// 接口ID：7426325309484040193 +/// 文档地址：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/approver/list +/// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2fcorehr-v2%2fapprover%2flist /// public record GetCorehrV2ApproversResponseDto { diff --git a/src/Corehr/PatchCorehrV2PersonsByPersonIdBodyDto.cs b/src/Corehr/PatchCorehrV2PersonsByPersonIdBodyDto.cs index 89858c63..37ff9055 100644 --- a/src/Corehr/PatchCorehrV2PersonsByPersonIdBodyDto.cs +++ b/src/Corehr/PatchCorehrV2PersonsByPersonIdBodyDto.cs @@ -23,6 +23,7 @@ public record PatchCorehrV2PersonsByPersonIdBodyDto { /// /// 姓名列表 + /// - 覆盖式更新 /// 必填：否 /// [JsonPropertyName("name_list")] @@ -30,6 +31,7 @@ public record PatchCorehrV2PersonsByPersonIdBodyDto /// /// 姓名列表 + /// - 覆盖式更新 /// public record PersonName { @@ -317,6 +319,7 @@ public record Enum /// /// 地址列表 + /// - 覆盖式更新 /// 必填：否 /// [JsonPropertyName("address_list")] @@ -324,11 +327,12 @@ public record Enum /// /// 地址列表 + /// - 覆盖式更新 /// public record Address { /// - /// 地址 ID，在[【创建个人信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/person/create)时返回的的地址ID；不可与其他地址使用相同 ID；为空时返回新的ID + /// 地址 ID，在[【创建个人信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/person/create)时返回的的地址ID；不可与其他地址使用相同 ID；为空时会返回新的ID /// 必填：否 /// 示例值：6989822217869624863 /// @@ -596,6 +600,7 @@ public record Email { /// /// 邮箱地址 + /// - 覆盖式更新 /// 必填：是 /// 示例值：1234567@example.feishu.cn /// @@ -654,6 +659,7 @@ public record Enum /// /// 工作经历列表 + /// - 覆盖式更新 /// 必填：否 /// [JsonPropertyName("work_experience_list")] @@ -661,6 +667,7 @@ public record Enum /// /// 工作经历列表 + /// - 覆盖式更新 /// public record WorkExperienceInfo { @@ -764,6 +771,7 @@ public record CustomFieldData /// /// 教育经历列表 + /// - 覆盖式更新 /// 必填：否 /// [JsonPropertyName("education_list")] @@ -771,6 +779,7 @@ public record CustomFieldData /// /// 教育经历列表 + /// - 覆盖式更新 /// public record Education { @@ -931,6 +940,7 @@ public record CustomFieldData /// /// 银行账户 + /// - 覆盖式更新 /// 必填：否 /// [JsonPropertyName("bank_account_list")] @@ -938,6 +948,7 @@ public record CustomFieldData /// /// 银行账户 + /// - 覆盖式更新 /// public record BankAccount { @@ -1077,6 +1088,7 @@ public record CustomFieldData /// /// 证件 + /// - 覆盖式更新 /// 必填：否 /// [JsonPropertyName("national_id_list")] @@ -1084,6 +1096,7 @@ public record CustomFieldData /// /// 证件 + /// - 覆盖式更新 /// public record NationalId { @@ -1169,6 +1182,7 @@ public record CustomFieldData /// /// 家庭成员列表 + /// - 覆盖式更新 /// 必填：否 /// [JsonPropertyName("dependent_list")] @@ -1176,6 +1190,7 @@ public record CustomFieldData /// /// 家庭成员列表 + /// - 覆盖式更新 /// public record Dependent { @@ -1693,6 +1708,7 @@ public record File /// /// 紧急联系人列表 + /// - 覆盖式更新 /// 必填：否 /// [JsonPropertyName("emergency_contact_list")] @@ -1700,6 +1716,7 @@ public record File /// /// 紧急联系人列表 + /// - 覆盖式更新 /// public record EmergencyContact { @@ -2217,6 +2234,7 @@ public record CustomFieldData /// /// 居民身份信息 + /// - 覆盖式更新 /// 必填：否 /// 示例值：6863326262618752123 /// @@ -2225,6 +2243,7 @@ public record CustomFieldData /// /// 居民身份信息 + /// - 覆盖式更新 /// public record ResidentTax { diff --git a/src/Corehr/PostCorehrV2BasicInfoTimeZonesSearchResponseDto.cs b/src/Corehr/PostCorehrV2BasicInfoTimeZonesSearchResponseDto.cs index cd2c7d40..78eca718 100644 --- a/src/Corehr/PostCorehrV2BasicInfoTimeZonesSearchResponseDto.cs +++ b/src/Corehr/PostCorehrV2BasicInfoTimeZonesSearchResponseDto.cs @@ -81,7 +81,7 @@ public record I18n public string? TimeZoneCode { get; set; } /// - /// UTC 时区偏移量 + /// UTC 时区偏移量（分钟） /// 必填：否 /// 示例值：-660 /// diff --git a/src/FeishuNetSdk.csproj b/src/FeishuNetSdk.csproj index 6078fd3f..c1356958 100644 --- a/src/FeishuNetSdk.csproj +++ b/src/FeishuNetSdk.csproj @@ -16,7 +16,7 @@ MIT 适用于飞书开放平台的.Net开发包 LICENSE - 3.0.7 + 3.0.8 diff --git a/src/FeishuPeople/GetCorehrV1CompaniesResponseDto.cs b/src/FeishuPeople/GetCorehrV1CompaniesResponseDto.cs index dc3bd15b..956a1ac4 100644 --- a/src/FeishuPeople/GetCorehrV1CompaniesResponseDto.cs +++ b/src/FeishuPeople/GetCorehrV1CompaniesResponseDto.cs @@ -364,14 +364,14 @@ public record I18n public I18n[]? PrimaryManagers { get; set; } /// - /// 自定义字段 + /// 自定义字段（该功能暂不支持，可忽略） /// 必填：否 /// [JsonPropertyName("custom_fields")] public ObjectFieldData[]? CustomFields { get; set; } /// - /// 自定义字段 + /// 自定义字段（该功能暂不支持，可忽略） /// public record ObjectFieldData { diff --git a/src/FeishuPeople/GetCorehrV1JobDatasByJobDataIdResponseDto.cs b/src/FeishuPeople/GetCorehrV1JobDatasByJobDataIdResponseDto.cs index a84c03a4..9c740a65 100644 --- a/src/FeishuPeople/GetCorehrV1JobDatasByJobDataIdResponseDto.cs +++ b/src/FeishuPeople/GetCorehrV1JobDatasByJobDataIdResponseDto.cs @@ -14,7 +14,7 @@ namespace FeishuNetSdk.FeishuPeople; /// /// 查询单个任职信息 响应体 -/// 根据 ID 查询单任职信息。 +/// 根据 ID 查询当前生效的主任职记录。所有主任职记录中只有一条记录版本当前生效 /// 接口ID：7017694651622014980 /// 文档地址：https://open.feishu.cn/document/server-docs/corehr-v1/employee/job_data/get /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fcorehr-v1%2fjob_data%2fget @@ -132,7 +132,7 @@ public record GetCorehrV1JobDatasByJobDataIdResponseDtoJobData public string EmploymentId { get; set; } = string.Empty; /// - /// 生效时间 + /// 任职记录版本的生效时间 /// 必填：是 /// 示例值：2020-05-01 00:00:00 /// @@ -140,7 +140,7 @@ public record GetCorehrV1JobDatasByJobDataIdResponseDtoJobData public string EffectiveTime { get; set; } = string.Empty; /// - /// 失效时间 + /// 任职记录版本的失效时间 /// 必填：否 /// 示例值：2020-05-02 00:00:00 /// diff --git a/src/Hire.Events/HireTalentTagSubscriptionV1EventBodyDto.cs b/src/Hire.Events/HireTalentTagSubscriptionV1EventBodyDto.cs new file mode 100644 index 00000000..d563c67b --- /dev/null +++ b/src/Hire.Events/HireTalentTagSubscriptionV1EventBodyDto.cs @@ -0,0 +1,155 @@ +// ************************************************************************ +// Assembly : FeishuNetSdk +// Author : yxr +// Created : 2024-10-18 +// +// Last Modified By : yxr +// Last Modified On : 2024-10-18 +// ************************************************************************ +// +// MIT +// +// 人才进展变更事件 事件体 +// ************************************************************************ +namespace FeishuNetSdk.Hire.Events; +/// +/// 人才进展变更事件 事件体 +/// 支持单独订阅有指定标签的人才进展，人才进展包括阶段变更、锁定、解锁，需要提前在「飞书招聘」-「设置」- 「候选人标签管理」里对指定标签勾选支持事件订阅{使用示例}(url=/api/tools/api_explore/api_explore_config?project=hire&version=v1&resource=talent&event=tag_subscription) +/// 接口ID：7404770953199697922 +/// 文档地址：https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent/events/tag_subscription +/// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fukTMukTMukTM%2fuMzM1YjLzMTN24yMzUjN%2fhire-v1%2ftalent%2fevents%2ftag_subscription +/// +public record HireTalentTagSubscriptionV1EventBodyDto() : EventBodyDto("hire.talent.tag_subscription_v1") +{ + /// + /// 人才 ID，详情可参考[获取人才详情](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/hire-v2/talent/get) + /// 必填：否 + /// + [JsonPropertyName("talent_id")] + public string? TalentId { get; set; } + + /// + /// 投递 ID，详情可参考[获取投递信息](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/application/get) + /// 必填：否 + /// + [JsonPropertyName("application_id")] + public string? ApplicationId { get; set; } + + /// + /// 变更类型 + /// **可选值有**： + /// 1:阶段变更,2:锁定,3:解锁 + /// 必填：否 + /// 可选值： + /// 1：阶段变更 + /// 2：锁定 + /// 3：解锁 + /// + /// + [JsonPropertyName("type")] + public int? Type { get; set; } + + /// + /// 人才标签 + /// 必填：否 + /// + [JsonPropertyName("tag")] + public TalentTag? Tag { get; set; } + + /// + /// + /// + public record TalentTag + { + /// + /// 标签 ID，可通过以下接口 + /// 获取人才标签信息[ + /// 获取人才标签信息列表](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent_tag/list) + /// 必填：否 + /// + [JsonPropertyName("id")] + public string? Id { get; set; } + + /// + /// 标签名称 + /// 必填：否 + /// + [JsonPropertyName("name")] + public I18nLanguage? Name { get; set; } + + /// + /// 描述名称 + /// 必填：否 + /// + [JsonPropertyName("description")] + public I18nLanguage? Description { get; set; } + } + + /// + /// 锁定状态 + /// **可选值有**： + /// 1:未锁定,2:锁定在其他职位,3:锁定在当前职位 + /// 必填：否 + /// 可选值： + /// 1：未锁定 + /// 2：锁定在其他职位 + /// 3：锁定在当前职位 + /// + /// + [JsonPropertyName("lock_status")] + public int? LockStatus { get; set; } + + /// + /// 投递阶段，如果变更类型为阶段变更，则为变更后的投递阶段 + /// 必填：否 + /// + [JsonPropertyName("application_stage")] + public ApplicationStageInfo? ApplicationStage { get; set; } + + /// + /// + /// + public record ApplicationStageInfo + { + /// + /// 阶段 ID，可通过以下接口获取投递阶段信息[获取招聘流程信息](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job_process/list) + /// 必填：否 + /// + [JsonPropertyName("id")] + public string? Id { get; set; } + + /// + /// 中文名称 + /// 必填：否 + /// + [JsonPropertyName("zh_name")] + public string? ZhName { get; set; } + + /// + /// 英文名称 + /// 必填：否 + /// + [JsonPropertyName("en_name")] + public string? EnName { get; set; } + + /// + /// 阶段类型 + /// **可选值有**： + /// 1:筛选型,2:评估型,3:笔试型,4:面试型,5:Offer型,6:待入职,7:已入职,8:其它类型,255:系统默认 + /// 必填：否 + /// 可选值： + /// 1：筛选型 + /// 2：评估型 + /// 3：笔试型 + /// 4：面试型 + /// 5：Offer型 + /// 6：待入职 + /// 7：已入职 + /// 8：其它类型 + /// 255：系统默认 + /// + /// + [JsonPropertyName("type")] + public int? Type { get; set; } + } +} diff --git a/src/Hire/GetHireV1TalentTagsResponseDto.cs b/src/Hire/GetHireV1TalentTagsResponseDto.cs new file mode 100644 index 00000000..759be54d --- /dev/null +++ b/src/Hire/GetHireV1TalentTagsResponseDto.cs @@ -0,0 +1,120 @@ +// ************************************************************************ +// Assembly : FeishuNetSdk +// Author : yxr +// Created : 2024-10-18 +// +// Last Modified By : yxr +// Last Modified On : 2024-10-18 +// ************************************************************************ +// +// MIT +// +// 获取人才标签信息列表 响应体 +// ************************************************************************ +namespace FeishuNetSdk.Hire; +/// +/// 获取人才标签信息列表 响应体 +/// 可通过关键词、ID 列表、标签类型、停用状态等获取人才标签信息列表，结果按照创建时间倒序排序。 +/// 接口ID：7404770953199714306 +/// 文档地址：https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent_tag/list +/// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fukTMukTMukTM%2fuMzM1YjLzMTN24yMzUjN%2fhire-v1%2ftalent_tag%2flist +/// +public record GetHireV1TalentTagsResponseDto +{ + /// + /// 标签列表 + /// 必填：否 + /// + [JsonPropertyName("items")] + public TalentTag[]? Items { get; set; } + + /// + /// 标签列表 + /// + public record TalentTag + { + /// + /// 标签 ID + /// 必填：否 + /// 示例值：7023711013443944467 + /// + [JsonPropertyName("id")] + public string? Id { get; set; } + + /// + /// 标签名称 + /// 必填：否 + /// + [JsonPropertyName("name")] + public I18n? Name { get; set; } + + /// + /// 标签名称 + /// + public record I18n + { + /// + /// 中文名称 + /// 必填：否 + /// 示例值：985 + /// + [JsonPropertyName("zh_cn")] + public string? ZhCn { get; set; } + + /// + /// 英文名称 + /// 必填：否 + /// 示例值：985 + /// + [JsonPropertyName("en_us")] + public string? EnUs { get; set; } + } + + /// + /// 描述名称 + /// 必填：否 + /// + [JsonPropertyName("description")] + public I18n? Description { get; set; } + + /// + /// 标签类型 + /// 必填：否 + /// 示例值：1 + /// 可选值： + /// 1：手动标签 + /// 2：自动标签 + /// + /// + [JsonPropertyName("type")] + public int? Type { get; set; } + + /// + /// 启停用状态 + /// 必填：否 + /// 示例值：1 + /// 可选值： + /// 1：启用 + /// 2：停用 + /// + /// + [JsonPropertyName("active_status")] + public int? ActiveStatus { get; set; } + } + + /// + /// 是否还有更多项 + /// 必填：否 + /// 示例值：true + /// + [JsonPropertyName("has_more")] + public bool? HasMore { get; set; } + + /// + /// 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token + /// 必填：否 + /// 示例值：eyJvZmZzZXQiOjEwLCJ0aW1lc3RhbXAiOjE2Mjc1NTUyMjM2NzIsImlkIjpudWxsfQ== + /// + [JsonPropertyName("page_token")] + public string? PageToken { get; set; } +} diff --git a/src/Hire/PostHireV1TalentsByTalentIdTagBodyDto.cs b/src/Hire/PostHireV1TalentsByTalentIdTagBodyDto.cs new file mode 100644 index 00000000..45745c7b --- /dev/null +++ b/src/Hire/PostHireV1TalentsByTalentIdTagBodyDto.cs @@ -0,0 +1,42 @@ +// ************************************************************************ +// Assembly : FeishuNetSdk +// Author : yxr +// Created : 2024-10-18 +// +// Last Modified By : yxr +// Last Modified On : 2024-10-18 +// ************************************************************************ +// +// MIT +// +// 操作人才标签 请求体 +// ************************************************************************ +namespace FeishuNetSdk.Hire; +/// +/// 操作人才标签 请求体 +/// 可为人才新增、删除标签。 +/// 接口ID：7404770953199730690 +/// 文档地址：https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent/tag +/// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fukTMukTMukTM%2fuMzM1YjLzMTN24yMzUjN%2fhire-v1%2ftalent%2ftag +/// +public record PostHireV1TalentsByTalentIdTagBodyDto +{ + /// + /// 操作类型 + /// 必填：是 + /// 示例值：1 + /// 可选值： + /// 1：新增 + /// 2：删除 + /// + /// + [JsonPropertyName("operation")] + public int Operation { get; set; } + + /// + /// 标签 ID 列表，可通过以下接口获取[获取人才标签信息列表](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent_tag/list) + /// 必填：是 + /// + [JsonPropertyName("tag_id_list")] + public string[] TagIdList { get; set; } = Array.Empty(); +} diff --git a/src/Hire/PostHireV1TalentsCombinedUpdateBodyDto.cs b/src/Hire/PostHireV1TalentsCombinedUpdateBodyDto.cs index 5483cb50..b996838d 100644 --- a/src/Hire/PostHireV1TalentsCombinedUpdateBodyDto.cs +++ b/src/Hire/PostHireV1TalentsCombinedUpdateBodyDto.cs @@ -70,7 +70,7 @@ public record PostHireV1TalentsCombinedUpdateBodyDto public int? OperatorAccountType { get; set; } /// - /// 简历附件 ID，如何创建附件请参考[创建附件](https://open.feishu.cn/document/ukTMukTMukTM/uIDN1YjLyQTN24iM0UjN/create_attachment) + /// 简历附件 ID，如何创建附件请参考[创建附件](https://open.feishu.cn/document/ukTMukTMukTM/uIDN1YjLyQTN24iM0UjN/create_attachment)；请注意：本接口仅会给人才增加一个附件简历，不会解析附件简历中的内容并更新人才 /// 必填：否 /// 示例值：7383906146040678700 /// diff --git a/src/Hire/PutHireV1JobRequirementsByJobRequirementIdBodyDto.cs b/src/Hire/PutHireV1JobRequirementsByJobRequirementIdBodyDto.cs index 3bcababb..54f4f18e 100644 --- a/src/Hire/PutHireV1JobRequirementsByJobRequirementIdBodyDto.cs +++ b/src/Hire/PutHireV1JobRequirementsByJobRequirementIdBodyDto.cs @@ -278,7 +278,7 @@ public record JobRequirementCustomizedData public string? JobTypeId { get; set; } /// - /// 关联的职位 ID 列表 + /// 关联的职位 ID 列表，该字段无效，请勿使用 /// 必填：否 /// 最大长度：200 /// diff --git a/src/IFeishuTenantApi.cs b/src/IFeishuTenantApi.cs index 8141cf1d..010c6b6d 100644 --- a/src/IFeishuTenantApi.cs +++ b/src/IFeishuTenantApi.cs @@ -4,7 +4,7 @@ // Created : 2024-06-24 // // Last Modified By : yxr -// Last Modified On : 2024-10-12 +// Last Modified On : 2024-10-18 // ************************************************************************ // // MIT @@ -5626,8 +5626,6 @@ System.Threading.Tasks.Task PutImV1ChatsByChatIdModerationAsync( /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/create /// Authorization：tenant_access_token、user_access_token /// 该接口用于在数据表中新增一条记录 - /// note - /// 首次调用请参考 [云文档接口快速入门](https://open.feishu.cn/document/ukTMukTMukTM/uczNzUjL3czM14yN3MTN)[多维表格接口接入指南](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bitable/notification) /// 权限要求： /// base:record:create /// bitable:app @@ -5643,13 +5641,24 @@ System.Threading.Tasks.Task PutImV1ChatsByChatIdModerationAsync( /// /// 路径参数 /// 必填：是 - /// 多维表格的唯一标识符 [app_token 参数说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bitable/notification#8121eebe) + /// 多维表格 App 的唯一标识。不同形态的多维表格，其 app_token 的获取方式不同： + /// - 如果多维表格的 URL 以 ==**feishu.cn/base**== 开头，该多维表格的 app_token 是下图高亮部分： + /// ![app_token.png](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/6916f8cfac4045ba6585b90e3afdfb0a_GxbfkJHZBa.png?height=766&lazyload=true&width=3004) + /// - 如果多维表格的 URL 以 ==**feishu.cn/wiki**== 开头，你需调用知识库相关[获取知识空间节点信息](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space/get_node)接口获取多维表格的 app_token。当 obj_type 的值为 bitable 时，obj_token 字段的值才是多维表格的 app_token。 + /// 了解更多，参考[多维表格 app_token 获取方式](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/bitable-overview#-752212c)。 + /// **数据校验规则**： + /// - 长度范围：`0` ～ `100` 字符 /// 示例值：bascng7vrxcxpig7geggXiCtadY /// /// /// 路径参数 /// 必填：是 - /// 多维表格数据表的唯一标识符 [table_id 参数说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bitable/notification#735fe883) + /// 多维表格数据表的唯一标识。获取方式： + /// - 你可通过多维表格 URL 获取 `table_id`，下图高亮部分即为当前数据表的 `table_id`。 + /// - 也可通过[列出数据表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/list)接口获取 `table_id`。 + /// ![](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/18741fe2a0d3cafafaf9949b263bb57d_yD1wkOrSju.png?height=746&lazyload=true&maxWidth=700&width=2976) + /// **数据校验规则**： + /// - 长度范围：`0` ～ `50` 字符 /// 示例值：tblUa9vcYjWQYJCj /// /// @@ -5993,13 +6002,20 @@ System.Threading.Tasks.Task PutImV1ChatsByChatIdModerationAsync( /// /// 路径参数 /// 必填：是 - /// 多维表格的唯一标识符 [app_token 参数说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bitable/notification#8121eebe) + /// 多维表格 App 的唯一标识。不同形态的多维表格，其 app_token 的获取方式不同： + /// - 如果多维表格的 URL 以 ==**feishu.cn/base**== 开头，该多维表格的 app_token 是下图高亮部分： + /// ![app_token.png](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/6916f8cfac4045ba6585b90e3afdfb0a_GxbfkJHZBa.png?height=766&lazyload=true&width=3004) + /// - 如果多维表格的 URL 以 ==**feishu.cn/wiki**== 开头，你需调用知识库相关[获取知识空间节点信息](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space/get_node)接口获取多维表格的 app_token。当 obj_type 的值为 bitable 时，obj_token 字段的值才是多维表格的 app_token。 + /// 了解更多，参考[多维表格 app_token 获取方式](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/bitable-overview#-752212c)。 /// 示例值：appbcbWCzen6D8dezhoCH2RpMAh /// /// /// 路径参数 /// 必填：是 - /// 多维表格数据表的唯一标识符 [table_id 参数说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bitable/notification#735fe883) + /// 多维表格数据表的唯一标识。获取方式： + /// - 你可通过多维表格 URL 获取 `table_id`，下图高亮部分即为当前数据表的 `table_id` + /// - 也可通过[列出数据表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/list)接口获取 `table_id` + /// ![](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/18741fe2a0d3cafafaf9949b263bb57d_yD1wkOrSju.png?height=746&lazyload=true&maxWidth=700&width=2976) /// 示例值：tblsRc9GRRXKqhvW /// /// @@ -6081,19 +6097,26 @@ System.Threading.Tasks.Task PutImV1ChatsByChatIdModerationAsync( /// /// 路径参数 /// 必填：是 - /// 多维表格的唯一标识符 [app_token 参数说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bitable/notification#8121eebe) + /// 多维表格 App 的唯一标识。不同形态的多维表格，其 app_token 的获取方式不同： + /// - 如果多维表格的 URL 以 ==**feishu.cn/base**== 开头，该多维表格的 app_token 是下图高亮部分： + /// ![app_token.png](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/6916f8cfac4045ba6585b90e3afdfb0a_GxbfkJHZBa.png?height=766&lazyload=true&width=3004) + /// - 如果多维表格的 URL 以 ==**feishu.cn/wiki**== 开头，你需调用知识库相关[获取知识空间节点信息](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space/get_node)接口获取多维表格的 app_token。当 obj_type 的值为 bitable 时，obj_token 字段的值才是多维表格的 app_token。 + /// 了解更多，参考[多维表格 app_token 获取方式](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/bitable-overview#-752212c)。 /// 示例值：appbcbWCzen6D8dezhoCH2RpMAh /// /// /// 路径参数 /// 必填：是 - /// 多维表格数据表的唯一标识符 [table_id 参数说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bitable/notification#735fe883) + /// 多维表格数据表的唯一标识。获取方式： + /// - 你可通过多维表格 URL 获取 `table_id`，下图高亮部分即为当前数据表的 `table_id` + /// - 也可通过[列出数据表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/list)接口获取 `table_id` + /// ![](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/18741fe2a0d3cafafaf9949b263bb57d_yD1wkOrSju.png?height=746&lazyload=true&maxWidth=700&width=2976) /// 示例值：tblsRc9GRRXKqhvW /// /// /// 路径参数 /// 必填：是 - /// 一条记录的唯一标识 id [record_id 参数说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bitable/notification#15d8db94) + /// 数据表中一条记录的唯一标识。通过[查询记录](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/search)接口获取。 /// 示例值：recqwIwhc6 /// /// @@ -9640,13 +9663,14 @@ System.Threading.Tasks.Task PostHelpdeskV1EventsUnsubscribeAsync /// /// 路径参数 /// 必填：是 - /// 多维表格的唯一标识符 [app_token 参数说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bitable/notification#8121eebe) + /// 目标多维表格 App 的唯一标识。不同形态的多维表格，其 app_token 的获取方式不同，参考[多维表格 app_token 获取方式](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/bitable-overview)获取。 /// 示例值：appbcbWCzen6D8dezhoCH2RpMAh /// /// /// 路径参数 /// 必填：是 - /// 多维表格数据表的唯一标识符 [table_id 参数说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bitable/notification#735fe883) + /// 多维表格数据表的唯一标识。你可通过多维表格 URL 获取 `table_id`，下图高亮部分即为当前数据表的 `table_id`。你也可通过[列出数据表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/list)接口获取 `table_id`。 + /// ![](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/18741fe2a0d3cafafaf9949b263bb57d_yD1wkOrSju.png?height=746&lazyload=true&maxWidth=700&width=2976) /// 示例值：tblsRc9GRRXKqhvW /// [HttpDelete("/open-apis/bitable/v1/apps/{app_token}/tables/{table_id}")] @@ -9670,7 +9694,7 @@ System.Threading.Tasks.Task DeleteBitableV1AppsByAppTokenTablesB /// /// 路径参数 /// 必填：是 - /// 多维表格的唯一标识符 [app_token 参数说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bitable/notification#8121eebe) + /// 目标多维表格 App 的唯一标识。不同形态的多维表格，其 app_token 的获取方式不同，参考[多维表格 app_token 获取方式](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/bitable-overview)获取。 /// 示例值：appbcbWCzen6D8dezhoCH2RpMAh /// /// 请求体 @@ -9694,7 +9718,7 @@ System.Threading.Tasks.Task PostBitableV1AppsByAppTokenTablesBat /// /// 路径参数 /// 必填：是 - /// 多维表格的唯一标识符 [app_token 参数说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bitable/notification#8121eebe) + /// 目标多维表格 App 的唯一标识。不同形态的多维表格，其 app_token 的获取方式不同，参考[多维表格 app_token 获取方式](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/bitable-overview)获取。 /// 示例值：appbcbWCzen6D8dezhoCH2RpMAh /// /// @@ -9849,9 +9873,7 @@ System.Threading.Tasks.Task PostBitableV1AppsByAppTokenTablesBat /// 接口ID：6960166873968541699 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/create /// Authorization：tenant_access_token、user_access_token - /// 通过该接口，可以新增一个仅包含索引列的空数据表，也可以指定一部分初始字段。 - /// note - /// 首次调用请参考 [云文档接口快速入门](https://open.feishu.cn/document/ukTMukTMukTM/uczNzUjL3czM14yN3MTN)[多维表格接口接入指南](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bitable/notification) + /// 新增一个数据表，默认仅包含索引列，也可以指定一部分初始字段。 /// 权限要求： /// base:table:create /// bitable:app @@ -9860,7 +9882,7 @@ System.Threading.Tasks.Task PostBitableV1AppsByAppTokenTablesBat /// /// 路径参数 /// 必填：是 - /// 多维表格的唯一标识符 [app_token 参数说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bitable/notification#8121eebe) + /// 目标多维表格 App 的唯一标识。不同形态的多维表格，其 app_token 的获取方式不同，参考[多维表格 app_token 获取方式](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/bitable-overview)获取。 /// 示例值：appbcbWCzen6D8dezhoCH2RpMAh /// /// 请求体 @@ -9886,7 +9908,7 @@ System.Threading.Tasks.Task PostBitableV1AppsByAppTokenTablesBat /// /// 路径参数 /// 必填：是 - /// 多维表格的唯一标识符 [app_token 参数说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bitable/notification#8121eebe) + /// 目标多维表格 App 的唯一标识。不同形态的多维表格，其 app_token 的获取方式不同，参考[多维表格 app_token 获取方式](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/bitable-overview)获取。 /// 示例值：appbcbWCzen6D8dezhoCH2RpMAh /// /// @@ -9912,9 +9934,7 @@ System.Threading.Tasks.Task PostBitableV1AppsByAppTokenTablesBat /// 接口ID：6960166873968574467 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app/get /// Authorization：tenant_access_token、user_access_token - /// 获取指定多维表格的元数据信息，包括多维表格名称，多维表格版本号，多维表格是否开启高级权限等。 - /// note - /// 首次调用请参考 [云文档接口快速入门](https://open.feishu.cn/document/ukTMukTMukTM/uczNzUjL3czM14yN3MTN)[多维表格接口接入指南](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bitable/notification) + /// 获取指定多维表格的元数据信息，包括多维表格名称、多维表格版本号、多维表格是否开启高级权限等。 /// 权限要求： /// base:app:read /// bitable:app @@ -9924,7 +9944,7 @@ System.Threading.Tasks.Task PostBitableV1AppsByAppTokenTablesBat /// /// 路径参数 /// 必填：是 - /// 多维表格的唯一标识符 [app_token 参数说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bitable/notification#8121eebe) + /// 目标多维表格 App 的唯一标识。不同形态的多维表格，其 app_token 的获取方式不同，参考[多维表格 app_token 获取方式](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/bitable-overview)获取。 /// 示例值：appbcbWCzen6D8dezhoCH2RpMAh /// [HttpGet("/open-apis/bitable/v1/apps/{app_token}")] @@ -17001,7 +17021,7 @@ System.Threading.Tasks.Task DeleteCorehrV1JobFamiliesByJobFamily /// 接口ID：7017694651622014980 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_data/get /// Authorization：tenant_access_token - /// 根据 ID 查询单任职信息。 + /// 根据 ID 查询当前生效的主任职记录。所有主任职记录中只有一条记录版本当前生效 /// 权限要求： /// corehr:corehr /// corehr:corehr:readonly @@ -20730,7 +20750,7 @@ System.Threading.Tasks.Task DeleteAttendanceV1ShiftsByShiftIdAsy /// 接口ID：7047048928294174722 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/image/upload /// Authorization：tenant_access_token、user_access_token - /// 上传进展记录图片。 + /// 上传进展记录图片。成功调用该接口后，你可继续调用[创建 OKR 进展记录](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/progress_record/create)或[更新 OKR 进展记录](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/progress_record/update)，将返回的 `url`参数和`file_token` 参数传入 `imageList` 参数中。 /// 权限要求： /// okr:okr /// @@ -20873,7 +20893,7 @@ System.Threading.Tasks.Task DeleteOkrV1ProgressRecordsByProgress /// 接口ID：7047733935745007620 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app/create /// Authorization：tenant_access_token、user_access_token - /// 在指定目录下创建多维表格 + /// 在指定文件夹中创建一个多维表格，包含一个空白的数据表。 /// 权限要求： /// base:app:create /// bitable:app @@ -22689,15 +22709,20 @@ System.Threading.Tasks.Task DeleteCorehrV1CompaniesByCompanyIdAs /// 接口ID：7073673019918811164 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app/update /// Authorization：tenant_access_token、user_access_token - /// 通过 app_token 更新多维表格元数据 + /// 更新多维表格元数据，包括多维表格的名称、是否开启高级权限。 + /// ## 注意事项 + /// - 在线文档和电子表格中嵌入的多维表格、知识库中的多维表格不支持开启高级权限。 + /// - 此接口非原子操作，先修改多维表格名称，后开关高级权限，可能存在部分成功的情况。 /// 权限要求： + /// base:app:update /// bitable:app /// /// /// /// 路径参数 /// 必填：是 - /// Base app token + /// 目标多维表格的 App token。该接口仅支持存储在云空间文件夹中的多维表格，即 URL 以 **feishu.cn/base** 开头的多维表格形态。该类多维表格的 app_token 为 URL 下图高亮部分： + /// ![](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/6916f8cfac4045ba6585b90e3afdfb0a_sTn7sVvhOB.png?height=766&lazyload=true&maxWidth=700&width=3004) /// 示例值：appbcbWCzen6D8dezhoCH2RpMAh /// /// 请求体 @@ -29884,19 +29909,21 @@ System.Threading.Tasks.Task PostMailV1MailgroupsByMailgroupIdMan /// note /// 首次调用请参考 [云文档接口快速入门](https://open.feishu.cn/document/ukTMukTMukTM/uczNzUjL3czM14yN3MTN)[多维表格接口接入指南](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bitable/notification) /// 权限要求： + /// base:table:update /// bitable:app /// /// /// /// 路径参数 /// 必填：是 - /// 多维表格的唯一标识符 [app_token 参数说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bitable/notification#8121eebe) + /// 目标多维表格 App 的唯一标识。不同形态的多维表格，其 app_token 的获取方式不同，参考[多维表格 app_token 获取方式](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/bitable-overview)获取。 /// 示例值：XrgTb4y1haKYnasu0xXb1g7lcSg /// /// /// 路径参数 /// 必填：是 - /// 多维表格数据表的唯一标识符 [table_id 参数说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bitable/notification#735fe883) + /// 多维表格数据表的唯一标识。你可通过多维表格 URL 获取 `table_id`，下图高亮部分即为当前数据表的 `table_id`。你也可通过[列出数据表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/list)接口获取 `table_id`。 + /// ![](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/18741fe2a0d3cafafaf9949b263bb57d_yD1wkOrSju.png?height=746&lazyload=true&maxWidth=700&width=2976) /// 示例值：tbl1TkhyTWDkSoZ3 /// /// 请求体 @@ -31901,6 +31928,8 @@ System.Threading.Tasks.Task PutContactV3FunctionalRolesByRoleIdA /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app/copy /// Authorization：tenant_access_token、user_access_token /// 复制一个多维表格，可以指定复制到某个有权限的文件夹下。 + /// ## 前提条件 + /// 调用此接口前，请确保当前调用身份（tenant_access_token 或 user_access_token）已有多维表格和目标文件夹的阅读、编辑等文档权限，否则接口将返回 HTTP 403 或 400 状态码。了解更多，参考[如何为应用或用户开通云文档权限](https://open.feishu.cn/document/ukTMukTMukTM/uczNzUjL3czM14yN3MTN#16c6475a)。 /// 权限要求： /// base:app:copy /// bitable:app @@ -31909,8 +31938,8 @@ System.Threading.Tasks.Task PutContactV3FunctionalRolesByRoleIdA /// /// 路径参数 /// 必填：是 - /// [多维表格 App token](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bitable/notification#8121eebe) - /// 示例值：S404b*****e9PQsYDWYcNryFn0g + /// 要复制的多维表格 App 的唯一标识。不同形态的多维表格，其 app_token 的获取方式不同，参考[多维表格 app_token 获取方式](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/bitable-overview)获取。 + /// 示例值：AW3Qbtr2cakCnesXzXVbbsrIcVT /// /// 请求体 [HttpPost("/open-apis/bitable/v1/apps/{app_token}/copy")] @@ -39421,19 +39450,20 @@ System.Threading.Tasks.Task DeleteHireV1TripartiteAgreementsByTr /// /// 路径参数 /// 必填：是 - /// 多维表格的唯一标识 token。获取方式： + /// 多维表格 App 的唯一标识。不同形态的多维表格，其 app_token 的获取方式不同： /// - 如果多维表格的 URL 以 ==**feishu.cn/base**== 开头，该多维表格的 app_token 是下图高亮部分： /// ![app_token.png](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/6916f8cfac4045ba6585b90e3afdfb0a_GxbfkJHZBa.png?height=766&lazyload=true&width=3004) - /// - 如果多维表格的 URL 以 ==**feishu.cn/wiki**== 开头，你需调用知识库相关[获取知识空间节点信息](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space/get_node)接口获取多维表格的 app_token。当 obj_type 的值为 bitable 时，obj_token 字段的值才是多维表格的 app_token。了解更多，参考[多维表格接入指南](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bitable/notification#8121eebe)。 + /// - 如果多维表格的 URL 以 ==**feishu.cn/wiki**== 开头，你需调用知识库相关[获取知识空间节点信息](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space/get_node)接口获取多维表格的 app_token。当 obj_type 的值为 bitable 时，obj_token 字段的值才是多维表格的 app_token。 + /// 了解更多，参考[多维表格 app_token 获取方式](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/bitable-overview#-752212c)。 /// 示例值：NQRxbRkBMa6OnZsjtERcxhNWnNh /// /// /// 路径参数 /// 必填：是 - /// 多维表格的数据表 ID。获取方式： - /// - 在多维表格的 URL 地址栏中，table_id 是下图中高亮部分： - /// ![table_id.png](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/18741fe2a0d3cafafaf9949b263bb57d_JD4VlW56qA.png?height=746&lazyload=true&width=2976) - /// - 对于其它场景的多维表格，如在云文档中嵌入的多维表格，则需要通过[列出数据表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/list)接口获取 + /// 多维表格数据表的唯一标识。获取方式： + /// - 你可通过多维表格 URL 获取 `table_id`，下图高亮部分即为当前数据表的 `table_id` + /// - 也可通过[列出数据表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/list)接口获取 `table_id` + /// ![](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/18741fe2a0d3cafafaf9949b263bb57d_yD1wkOrSju.png?height=746&lazyload=true&maxWidth=700&width=2976) /// 示例值：tbl0xe5g8PP3U3cS /// /// @@ -40866,6 +40896,324 @@ System.Threading.Tasks.Task PostApaasV1ApprovalTasksByApprovalTa [PathQuery] string pre_hire_id, [JsonContent] Corehr.PostCorehrV2PreHiresByPreHireIdTransitTaskBodyDto dto); + /// + /// 【智能伙伴创建平台】获取消息 + /// 接口ID：7358047310868152324 + /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session-aily_message/get + /// Authorization：tenant_access_token、user_access_token + /// 该 API 用于获取某个飞书智能伙伴应用的消息（Message）的详细信息；包括消息的内容、发送人等。 + /// ## 实体概念说明 + /// - **会话**（Session）：管理用户与 Aily 助手之间的交互会话；每次会话记录了用户发送给 Aily 助手的消息以及 Aily 助手的响应。 + /// - **消息**（Message）：消息可以包含文本、表格、图片等多种类型的内容。 + /// - **运行**（Run）：Aily 助手基于会话内消息进行意图判定、调用匹配的技能，并返回技能执行后的结果消息。 + /// 权限要求： + /// aily:message:read + /// + /// + /// + /// 路径参数 + /// 必填：是 + /// 会话 ID；参考 [创建会话](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/app-session/create) 接口 + /// 示例值：session_4dfunz7sp1g8m + /// + /// + /// 路径参数 + /// 必填：是 + /// 消息 ID + /// 示例值：message_4df45f2xknvcc + /// + [HttpGet("/open-apis/aily/v1/sessions/{aily_session_id}/messages/{aily_message_id}")] + System.Threading.Tasks.Task> GetAilyV1SessionsByAilySessionIdMessagesByAilyMessageIdAsync( + [PathQuery] string aily_session_id, + [PathQuery] string aily_message_id); + + /// + /// 【智能伙伴创建平台】列出消息 + /// 接口ID：7358047310868168708 + /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session-aily_message/list + /// Authorization：tenant_access_token、user_access_token + /// 该 API 用于列出某个飞书智能伙伴应用的某个会话（Session）下消息（Message）的详细信息；包括消息的内容、发送人等。 + /// ## 实体概念说明 + /// - **会话**（Session）：管理用户与 Aily 助手之间的交互会话；每次会话记录了用户发送给 Aily 助手的消息以及 Aily 助手的响应。 + /// - **消息**（Message）：消息可以包含文本、表格、图片等多种类型的内容。 + /// - **运行**（Run）：Aily 助手基于会话内消息进行意图判定、调用匹配的技能，并返回技能执行后的结果消息。 + /// 权限要求： + /// aily:message:read + /// + /// + /// + /// 路径参数 + /// 必填：是 + /// 会话 ID；参考 [创建会话](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/app-session/create) 接口 + /// 示例值：session_4dfunz7sp1g8m + /// + /// + /// 必填：否 + /// 本次请求获取的消息记录条数，默认 20 + /// 示例值：20 + /// 默认值：10 + /// + /// + /// 必填：否 + /// 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 + /// 示例值：eVQrYzJBNDNONlk4VFZBZVlSdzlKdFJ4bVVHVExENDNKVHoxaVdiVnViQT0= + /// 默认值：null + /// + /// + /// 必填：否 + /// 过滤条件，按执行的唯一 ID 筛选 + /// 示例值：run_4dfrxvctjqzzj + /// 默认值：null + /// + /// + /// 必填：否 + /// 是否返回正在进行中（即流式输出中）的消息内容 + /// - 当设置为 `true` 时，返回的消息记录中、每个消息将额外包含一个 `status `字段（`IN_PROGRESS` | `COMPLETED`），此时 `content` 字段为当前时刻的消息内容 + /// - 当设置为 `false` 时，返回的消息记录仅包含已完成的消息 + /// 示例值：false + /// 默认值：null + /// + [HttpGet("/open-apis/aily/v1/sessions/{aily_session_id}/messages")] + System.Threading.Tasks.Task> GetAilyV1SessionsByAilySessionIdMessagesAsync( + [PathQuery] string aily_session_id, + [PathQuery] int? page_size = 10, + [PathQuery] string? page_token = null, + [PathQuery] string? run_id = null, + [PathQuery] bool? with_partial_message = null); + + /// + /// 【智能伙伴创建平台】创建运行 + /// 接口ID：7358047310868185092 + /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session-run/create + /// Authorization：tenant_access_token、user_access_token + /// 该 API 用于在某个飞书智能伙伴应用会话（Session）上创建一次运行（Run）。 + /// ## 实体概念说明 + /// - **会话**（Session）：管理用户与 Aily 助手之间的交互会话；每次会话记录了用户发送给 Aily 助手的消息以及 Aily 助手的响应。 + /// - **消息**（Message）：消息可以包含文本、表格、图片等多种类型的内容。 + /// - **运行**（Run）：Aily 助手基于会话内消息进行意图判定、调用匹配的技能，并返回技能执行后的结果消息。 + /// 权限要求： + /// aily:run:write + /// + /// + /// + /// 路径参数 + /// 必填：是 + /// 会话 ID；参考 [创建会话](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/app-session/create) 接口 + /// 示例值：session_4dfunz7sp1g8m + /// + /// 请求体 + [HttpPost("/open-apis/aily/v1/sessions/{aily_session_id}/runs")] + System.Threading.Tasks.Task> PostAilyV1SessionsByAilySessionIdRunsAsync( + [PathQuery] string aily_session_id, + [JsonContent] Aily.PostAilyV1SessionsByAilySessionIdRunsBodyDto dto); + + /// + /// 【智能伙伴创建平台】列出运行 + /// 接口ID：7358047310868201476 + /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session-run/list + /// Authorization：tenant_access_token、user_access_token + /// 该 API 用于列出某个飞书智能伙伴应用的运行（Run）的详细信息；包括状态、结束时间等。 + /// ## 实体概念说明 + /// - **会话**（Session）：管理用户与 Aily 助手之间的交互会话；每次会话记录了用户发送给 Aily 助手的消息以及 Aily 助手的响应。 + /// - **消息**（Message）：消息可以包含文本、表格、图片等多种类型的内容。 + /// - **运行**（Run）：Aily 助手基于会话内消息进行意图判定、调用匹配的技能，并返回技能执行后的结果消息。 + /// 权限要求： + /// aily:run:read + /// + /// + /// + /// 路径参数 + /// 必填：是 + /// 会话 ID；参考 [创建会话](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/app-session/create) 接口 + /// 示例值：session_4dfunz7sp1g8m + /// + /// + /// 必填：否 + /// 本次请求获取的运行记录条数，默认 20 + /// 示例值：20 + /// 默认值：10 + /// + /// + /// 必填：否 + /// 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 + /// 示例值：eVQrYzJBNDNONlk4VFZBZVlSdzlKdFJ4bVVHVExENDNKVHoxaVdiVnViQT0= + /// 默认值：null + /// + [HttpGet("/open-apis/aily/v1/sessions/{aily_session_id}/runs")] + System.Threading.Tasks.Task> GetAilyV1SessionsByAilySessionIdRunsAsync( + [PathQuery] string aily_session_id, + [PathQuery] int? page_size = 10, + [PathQuery] string? page_token = null); + + /// + /// 【智能伙伴创建平台】取消运行 + /// 接口ID：7358047310868217860 + /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session-run/cancel + /// Authorization：tenant_access_token、user_access_token + /// 该 API 用于中止某个飞书智能伙伴的一次运行。 + /// ## 实体概念说明 + /// - **会话**（Session）：管理用户与 Aily 助手之间的交互会话；每次会话记录了用户发送给 Aily 助手的消息以及 Aily 助手的响应。 + /// - **消息**（Message）：消息可以包含文本、表格、图片等多种类型的内容。 + /// - **运行**（Run）：Aily 助手基于会话内消息进行意图判定、调用匹配的技能，并返回技能执行后的结果消息。 + /// 权限要求： + /// aily:run:write + /// + /// + /// + /// 路径参数 + /// 必填：是 + /// 会话 ID；参考 [创建会话](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/app-session/create) 接口 + /// 示例值：session_4dfunz7sp1g8m + /// + /// + /// 路径参数 + /// 必填：是 + /// 运行的唯一 ID + /// 示例值：run_4dfrxvctjqzzj + /// + [HttpPost("/open-apis/aily/v1/sessions/{aily_session_id}/runs/{run_id}/cancel")] + System.Threading.Tasks.Task> PostAilyV1SessionsByAilySessionIdRunsByRunIdCancelAsync( + [PathQuery] string aily_session_id, + [PathQuery] string run_id); + + /// + /// 【智能伙伴创建平台】更新会话 + /// 接口ID：7358047310868234244 + /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session/update + /// Authorization：tenant_access_token、user_access_token + /// 该 API 用于更新与某个飞书智能伙伴应用的一次会话（Session）的信息。 + /// 权限要求： + /// aily:session:write + /// + /// + /// + /// 路径参数 + /// 必填：是 + /// 会话 ID + /// 示例值：session_4dfunz7sp1g8m + /// + /// 请求体 + [HttpPut("/open-apis/aily/v1/sessions/{aily_session_id}")] + System.Threading.Tasks.Task> PutAilyV1SessionsByAilySessionIdAsync( + [PathQuery] string aily_session_id, + [JsonContent] Aily.PutAilyV1SessionsByAilySessionIdBodyDto dto); + + /// + /// 【智能伙伴创建平台】获取会话 + /// 接口ID：7358047310868250628 + /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session/get + /// Authorization：tenant_access_token、user_access_token + /// 该 API 用于获取与某个飞书智能伙伴应用的一次会话（Session）的详细信息，包括会话的状态、渠道上下文、创建时间等。 + /// 权限要求： + /// aily:session:read + /// + /// + /// + /// 路径参数 + /// 必填：是 + /// 会话 ID + /// 示例值：session_4dfunz7sp1g8m + /// + [HttpGet("/open-apis/aily/v1/sessions/{aily_session_id}")] + System.Threading.Tasks.Task> GetAilyV1SessionsByAilySessionIdAsync( + [PathQuery] string aily_session_id); + + /// + /// 【智能伙伴创建平台】删除会话 + /// 接口ID：7358047310868267012 + /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session/delete + /// Authorization：tenant_access_token、user_access_token + /// 该 API 用于删除与某个飞书智能伙伴应用的一次会话（Session）。 + /// 权限要求： + /// aily:session:write + /// + /// + /// + /// 路径参数 + /// 必填：是 + /// 会话 ID + /// 示例值：session_4dfunz7sp1g8m + /// + [HttpDelete("/open-apis/aily/v1/sessions/{aily_session_id}")] + System.Threading.Tasks.Task DeleteAilyV1SessionsByAilySessionIdAsync( + [PathQuery] string aily_session_id); + + /// + /// 【智能伙伴创建平台】发送消息 + /// 接口ID：7358047310868283396 + /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session-aily_message/create + /// Authorization：tenant_access_token、user_access_token + /// 该 API 用于向某个飞书智能伙伴应用发送一条消息（Message）；每个消息从属于一个活跃的会话（Session）。 + /// ## 实体概念说明 + /// - **会话**（Session）：管理用户与 Aily 助手之间的交互会话；每次会话记录了用户发送给 Aily 助手的消息以及 Aily 助手的响应。 + /// - **消息**（Message）：消息可以包含文本、表格、图片等多种类型的内容。 + /// - **运行**（Run）：Aily 助手基于会话内消息进行意图判定、调用匹配的技能，并返回技能执行后的结果消息。 + /// 权限要求： + /// aily:message:write + /// + /// + /// + /// 路径参数 + /// 必填：是 + /// 会话 ID；参考 [创建会话](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/app-session/create) 接口 + /// 示例值：session_4dfunz7sp1g8m + /// + /// 请求体 + [HttpPost("/open-apis/aily/v1/sessions/{aily_session_id}/messages")] + System.Threading.Tasks.Task> PostAilyV1SessionsByAilySessionIdMessagesAsync( + [PathQuery] string aily_session_id, + [JsonContent] Aily.PostAilyV1SessionsByAilySessionIdMessagesBodyDto dto); + + /// + /// 【智能伙伴创建平台】获取运行 + /// 接口ID：7358047310868299780 + /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session-run/get + /// Authorization：tenant_access_token、user_access_token + /// 该 API 用于获取某个飞书智能伙伴应用的运行（Run）的详细信息；包括运行的状态、结束时间等。 + /// ## 实体概念说明 + /// - **会话**（Session）：管理用户与 Aily 助手之间的交互会话；每次会话记录了用户发送给 Aily 助手的消息以及 Aily 助手的响应。 + /// - **消息**（Message）：消息可以包含文本、表格、图片等多种类型的内容。 + /// - **运行**（Run）：Aily 助手基于会话内消息进行意图判定、调用匹配的技能，并返回技能执行后的结果消息。 + /// 权限要求： + /// aily:run:read + /// + /// + /// + /// 路径参数 + /// 必填：是 + /// 会话 ID；参考 [创建会话](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/app-session/create) 接口 + /// 示例值：session_4dfunz7sp1g8m + /// + /// + /// 路径参数 + /// 必填：是 + /// 运行的唯一 ID + /// 示例值：run_4dfrxvctjqzzj + /// + [HttpGet("/open-apis/aily/v1/sessions/{aily_session_id}/runs/{run_id}")] + System.Threading.Tasks.Task> GetAilyV1SessionsByAilySessionIdRunsByRunIdAsync( + [PathQuery] string aily_session_id, + [PathQuery] string run_id); + + /// + /// 【智能伙伴创建平台】创建会话 + /// 接口ID：7358047310868316164 + /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session/create + /// Authorization：tenant_access_token、user_access_token + /// 该 API 用于创建与某个飞书智能伙伴应用的一次会话（Session）；当创建会话成功后，可以发送消息、创建运行。 + /// ## 实体概念说明 + /// - **会话**（Session）：管理用户与 Aily 助手之间的交互会话；每次会话记录了用户发送给 Aily 助手的消息以及 Aily 助手的响应。 + /// - **消息**（Message）：消息可以包含文本、表格、图片等多种类型的内容。 + /// - **运行**（Run）：Aily 助手基于会话内消息进行意图判定、调用匹配的技能，并返回技能执行后的结果消息。 + /// 权限要求： + /// aily:session:write + /// + /// + /// 请求体 + [HttpPost("/open-apis/aily/v1/sessions")] + System.Threading.Tasks.Task> PostAilyV1SessionsAsync( + [JsonContent] Aily.PostAilyV1SessionsBodyDto dto); + /// /// 【消息与群组】更新 URL 预览 /// 接口ID：7358413940747862020 @@ -42807,6 +43155,87 @@ System.Threading.Tasks.Task PostHireV1ApplicationsByApplicationI System.Threading.Tasks.Task GetBoardV1WhiteboardsByWhiteboardIdDownloadAsImageAsync( [PathQuery] string whiteboard_id); + /// + /// 【招聘】获取人才标签信息列表 + /// 接口ID：7404770953199714306 + /// 接口文档：https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent_tag/list + /// Authorization：tenant_access_token + /// 可通过关键词、ID 列表、标签类型、停用状态等获取人才标签信息列表，结果按照创建时间倒序排序。 + /// 权限要求： + /// hire:talent_tag + /// hire:talent_tag:readonly + /// + /// + /// + /// 必填：否 + /// 搜索关键词 + /// 示例值：985 + /// 默认值：null + /// + /// + /// 必填：否 + /// ID 列表 + /// 默认值：null + /// + /// + /// 必填：否 + /// 标签类型 + /// 示例值：1 + /// + /// 1：手动标签 + /// 2：自动标签 + /// + /// 默认值：null + /// + /// + /// 必填：否 + /// 是否包含停用标签 + /// 示例值：true + /// 默认值：null + /// + /// + /// 必填：否 + /// 分页大小 + /// 示例值：20 + /// 默认值：20 + /// + /// + /// 必填：否 + /// 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 + /// 示例值：eyJvZmZzZXQiOjEwLCJ0aW1lc3RhbXAiOjE2Mjc1NTUyMjM2NzIsImlkIjpudWxsfQ== + /// 默认值：null + /// + [HttpGet("/open-apis/hire/v1/talent_tags")] + System.Threading.Tasks.Task> GetHireV1TalentTagsAsync( + [PathQuery] string? keyword = null, + [PathQuery] string[]? id_list = null, + [PathQuery] int? type = null, + [PathQuery] bool? include_inactive = null, + [PathQuery] int? page_size = 20, + [PathQuery] string? page_token = null); + + /// + /// 【招聘】操作人才标签 + /// 接口ID：7404770953199730690 + /// 接口文档：https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent/tag + /// Authorization：tenant_access_token + /// 可为人才新增、删除标签。 + /// 权限要求： + /// hire:talent + /// + /// + /// + /// 路径参数 + /// 必填：是 + /// 人才 ID，可通过[批量获取人才ID](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent/batch_get_id)获取 + /// 示例值：6960663240925956661 + /// + /// 请求体 + [HttpPost("/open-apis/hire/v1/talents/{talent_id}/tag")] + System.Threading.Tasks.Task PostHireV1TalentsByTalentIdTagAsync( + [PathQuery] string talent_id, + [JsonContent] Hire.PostHireV1TalentsByTalentIdTagBodyDto dto); + /// /// 【飞书人事（企业版）】查询指定生效日期的部门架构树 /// 接口ID：7405851978397581314 @@ -43179,55 +43608,6 @@ System.Threading.Tasks.Task PostApaasV1ApplicationsByNamespaceRo [PathQuery] string role_api_name, [JsonContent] AppEngine.PostApaasV1ApplicationsByNamespaceRolesByRoleApiNameMemberBatchCreateAuthorizationBodyDto dto); - /// - /// 【飞书人事（企业版）】获取指定人员审批任务列表 - /// 接口ID：7419213540896423940 - /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/process_approver/list - /// Authorization：tenant_access_token - /// 审批任务依赖于流程节点实例存在，每一个流程节点实例可能包含有一或多个审批任务，每一个任务表明当前节点的审批人是谁，该接口可获取指定人员的审批任务列表。 - /// 权限要求： - /// corehr:process:read - /// - /// 字段权限要求： - /// contact:user.employee_id:readonly - /// - /// - /// - /// 必填：是 - /// 分页大小 - /// 示例值：20 - /// 默认值：20 - /// - /// - /// 必填：否 - /// 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 - /// 示例值：1 - /// 默认值：1 - /// - /// - /// 必填：否 - /// 用户 ID 类型 - /// 示例值：open_id - /// - /// open_id：标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。[了解更多：如何获取 Open ID](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid) - /// union_id：标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。[了解更多：如何获取 Union ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-union-id) - /// user_id：标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。[了解更多：如何获取 User ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-user-id) - /// people_corehr_id：以飞书人事的 ID 来识别用户 - /// - /// 默认值：open_id - /// - /// - /// 必填：是 - /// 指定人员id，按user_id_type类型传递。 - /// 示例值：ou_91791271921729102012 - /// - [HttpGet("/open-apis/corehr/v2/approvers")] - System.Threading.Tasks.Task> GetCorehrV2ApproversAsync( - [PathQuery] string user_id, - [PathQuery] int page_size = 20, - [PathQuery] string? page_token = "1", - [PathQuery] string? user_id_type = "open_id"); - /// /// 【飞书人事（企业版）】删除职等 /// 接口ID：7422326822924550146 @@ -43358,5 +43738,54 @@ System.Threading.Tasks.Task PatchCorehrV2JobGradesByJobGradeIdAs [JsonContent] Corehr.PostCorehrV2BasicInfoTimeZonesSearchBodyDto dto, [PathQuery] int page_size = 10, [PathQuery] string? page_token = null); + + /// + /// 【飞书人事（企业版）】获取指定人员审批任务列表 + /// 接口ID：7426325309484040193 + /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/approver/list + /// Authorization：tenant_access_token + /// 审批任务依赖于流程节点实例存在，每一个流程节点实例可能包含有一或多个审批任务，每一个任务表明当前节点的审批人是谁，该接口可获取指定人员的审批任务列表。 + /// 权限要求： + /// corehr:process:read + /// + /// 字段权限要求： + /// contact:user.employee_id:readonly + /// + /// + /// + /// 必填：是 + /// 分页大小 + /// 示例值：20 + /// 默认值：20 + /// + /// + /// 必填：否 + /// 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 + /// 示例值：1 + /// 默认值：1 + /// + /// + /// 必填：否 + /// 用户 ID 类型 + /// 示例值：open_id + /// + /// open_id：标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。[了解更多：如何获取 Open ID](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid) + /// union_id：标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。[了解更多：如何获取 Union ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-union-id) + /// user_id：标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。[了解更多：如何获取 User ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-user-id) + /// people_corehr_id：以飞书人事的 ID 来识别用户 + /// + /// 默认值：open_id + /// + /// + /// 必填：是 + /// 指定人员id，按user_id_type类型传递。 + /// 示例值：ou_91791271921729102012 + /// + [HttpGet("/open-apis/corehr/v2/approvers")] + System.Threading.Tasks.Task> GetCorehrV2ApproversAsync( + [PathQuery] string user_id, + [PathQuery] int page_size = 20, + [PathQuery] string? page_token = "1", + [PathQuery] string? user_id_type = "open_id"); } diff --git a/src/IFeishuUserApi.cs b/src/IFeishuUserApi.cs index 360c3647..695d6bba 100644 --- a/src/IFeishuUserApi.cs +++ b/src/IFeishuUserApi.cs @@ -4,7 +4,7 @@ // Created : 2024-06-24 // // Last Modified By : yxr -// Last Modified On : 2024-10-12 +// Last Modified On : 2024-10-18 // ************************************************************************ // // MIT @@ -2959,8 +2959,6 @@ System.Threading.Tasks.Task PutImV1ChatsByChatIdModerationAsync( /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/create /// Authorization：tenant_access_token、user_access_token /// 该接口用于在数据表中新增一条记录 - /// note - /// 首次调用请参考 [云文档接口快速入门](https://open.feishu.cn/document/ukTMukTMukTM/uczNzUjL3czM14yN3MTN)[多维表格接口接入指南](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bitable/notification) /// 权限要求： /// base:record:create /// bitable:app @@ -2976,13 +2974,24 @@ System.Threading.Tasks.Task PutImV1ChatsByChatIdModerationAsync( /// /// 路径参数 /// 必填：是 - /// 多维表格的唯一标识符 [app_token 参数说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bitable/notification#8121eebe) + /// 多维表格 App 的唯一标识。不同形态的多维表格，其 app_token 的获取方式不同： + /// - 如果多维表格的 URL 以 ==**feishu.cn/base**== 开头，该多维表格的 app_token 是下图高亮部分： + /// ![app_token.png](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/6916f8cfac4045ba6585b90e3afdfb0a_GxbfkJHZBa.png?height=766&lazyload=true&width=3004) + /// - 如果多维表格的 URL 以 ==**feishu.cn/wiki**== 开头，你需调用知识库相关[获取知识空间节点信息](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space/get_node)接口获取多维表格的 app_token。当 obj_type 的值为 bitable 时，obj_token 字段的值才是多维表格的 app_token。 + /// 了解更多，参考[多维表格 app_token 获取方式](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/bitable-overview#-752212c)。 + /// **数据校验规则**： + /// - 长度范围：`0` ～ `100` 字符 /// 示例值：bascng7vrxcxpig7geggXiCtadY /// /// /// 路径参数 /// 必填：是 - /// 多维表格数据表的唯一标识符 [table_id 参数说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bitable/notification#735fe883) + /// 多维表格数据表的唯一标识。获取方式： + /// - 你可通过多维表格 URL 获取 `table_id`，下图高亮部分即为当前数据表的 `table_id`。 + /// - 也可通过[列出数据表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/list)接口获取 `table_id`。 + /// ![](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/18741fe2a0d3cafafaf9949b263bb57d_yD1wkOrSju.png?height=746&lazyload=true&maxWidth=700&width=2976) + /// **数据校验规则**： + /// - 长度范围：`0` ～ `50` 字符 /// 示例值：tblUa9vcYjWQYJCj /// /// @@ -3336,13 +3345,20 @@ System.Threading.Tasks.Task PutImV1ChatsByChatIdModerationAsync( /// /// 路径参数 /// 必填：是 - /// 多维表格的唯一标识符 [app_token 参数说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bitable/notification#8121eebe) + /// 多维表格 App 的唯一标识。不同形态的多维表格，其 app_token 的获取方式不同： + /// - 如果多维表格的 URL 以 ==**feishu.cn/base**== 开头，该多维表格的 app_token 是下图高亮部分： + /// ![app_token.png](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/6916f8cfac4045ba6585b90e3afdfb0a_GxbfkJHZBa.png?height=766&lazyload=true&width=3004) + /// - 如果多维表格的 URL 以 ==**feishu.cn/wiki**== 开头，你需调用知识库相关[获取知识空间节点信息](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space/get_node)接口获取多维表格的 app_token。当 obj_type 的值为 bitable 时，obj_token 字段的值才是多维表格的 app_token。 + /// 了解更多，参考[多维表格 app_token 获取方式](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/bitable-overview#-752212c)。 /// 示例值：appbcbWCzen6D8dezhoCH2RpMAh /// /// /// 路径参数 /// 必填：是 - /// 多维表格数据表的唯一标识符 [table_id 参数说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bitable/notification#735fe883) + /// 多维表格数据表的唯一标识。获取方式： + /// - 你可通过多维表格 URL 获取 `table_id`，下图高亮部分即为当前数据表的 `table_id` + /// - 也可通过[列出数据表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/list)接口获取 `table_id` + /// ![](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/18741fe2a0d3cafafaf9949b263bb57d_yD1wkOrSju.png?height=746&lazyload=true&maxWidth=700&width=2976) /// 示例值：tblsRc9GRRXKqhvW /// /// @@ -3428,19 +3444,26 @@ System.Threading.Tasks.Task PutImV1ChatsByChatIdModerationAsync( /// /// 路径参数 /// 必填：是 - /// 多维表格的唯一标识符 [app_token 参数说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bitable/notification#8121eebe) + /// 多维表格 App 的唯一标识。不同形态的多维表格，其 app_token 的获取方式不同： + /// - 如果多维表格的 URL 以 ==**feishu.cn/base**== 开头，该多维表格的 app_token 是下图高亮部分： + /// ![app_token.png](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/6916f8cfac4045ba6585b90e3afdfb0a_GxbfkJHZBa.png?height=766&lazyload=true&width=3004) + /// - 如果多维表格的 URL 以 ==**feishu.cn/wiki**== 开头，你需调用知识库相关[获取知识空间节点信息](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space/get_node)接口获取多维表格的 app_token。当 obj_type 的值为 bitable 时，obj_token 字段的值才是多维表格的 app_token。 + /// 了解更多，参考[多维表格 app_token 获取方式](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/bitable-overview#-752212c)。 /// 示例值：appbcbWCzen6D8dezhoCH2RpMAh /// /// /// 路径参数 /// 必填：是 - /// 多维表格数据表的唯一标识符 [table_id 参数说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bitable/notification#735fe883) + /// 多维表格数据表的唯一标识。获取方式： + /// - 你可通过多维表格 URL 获取 `table_id`，下图高亮部分即为当前数据表的 `table_id` + /// - 也可通过[列出数据表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/list)接口获取 `table_id` + /// ![](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/18741fe2a0d3cafafaf9949b263bb57d_yD1wkOrSju.png?height=746&lazyload=true&maxWidth=700&width=2976) /// 示例值：tblsRc9GRRXKqhvW /// /// /// 路径参数 /// 必填：是 - /// 一条记录的唯一标识 id [record_id 参数说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bitable/notification#15d8db94) + /// 数据表中一条记录的唯一标识。通过[查询记录](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/search)接口获取。 /// 示例值：recqwIwhc6 /// /// @@ -5353,13 +5376,14 @@ System.Threading.Tasks.Task DeleteHelpdeskV1CategoriesByIdAsync( /// /// 路径参数 /// 必填：是 - /// 多维表格的唯一标识符 [app_token 参数说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bitable/notification#8121eebe) + /// 目标多维表格 App 的唯一标识。不同形态的多维表格，其 app_token 的获取方式不同，参考[多维表格 app_token 获取方式](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/bitable-overview)获取。 /// 示例值：appbcbWCzen6D8dezhoCH2RpMAh /// /// /// 路径参数 /// 必填：是 - /// 多维表格数据表的唯一标识符 [table_id 参数说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bitable/notification#735fe883) + /// 多维表格数据表的唯一标识。你可通过多维表格 URL 获取 `table_id`，下图高亮部分即为当前数据表的 `table_id`。你也可通过[列出数据表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/list)接口获取 `table_id`。 + /// ![](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/18741fe2a0d3cafafaf9949b263bb57d_yD1wkOrSju.png?height=746&lazyload=true&maxWidth=700&width=2976) /// 示例值：tblsRc9GRRXKqhvW /// /// 用户凭证 @@ -5385,7 +5409,7 @@ System.Threading.Tasks.Task DeleteBitableV1AppsByAppTokenTablesB /// /// 路径参数 /// 必填：是 - /// 多维表格的唯一标识符 [app_token 参数说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bitable/notification#8121eebe) + /// 目标多维表格 App 的唯一标识。不同形态的多维表格，其 app_token 的获取方式不同，参考[多维表格 app_token 获取方式](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/bitable-overview)获取。 /// 示例值：appbcbWCzen6D8dezhoCH2RpMAh /// /// 请求体 @@ -5411,7 +5435,7 @@ System.Threading.Tasks.Task PostBitableV1AppsByAppTokenTablesBat /// /// 路径参数 /// 必填：是 - /// 多维表格的唯一标识符 [app_token 参数说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bitable/notification#8121eebe) + /// 目标多维表格 App 的唯一标识。不同形态的多维表格，其 app_token 的获取方式不同，参考[多维表格 app_token 获取方式](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/bitable-overview)获取。 /// 示例值：appbcbWCzen6D8dezhoCH2RpMAh /// /// @@ -5574,9 +5598,7 @@ System.Threading.Tasks.Task PostBitableV1AppsByAppTokenTablesBat /// 接口ID：6960166873968541699 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/create /// Authorization：tenant_access_token、user_access_token - /// 通过该接口，可以新增一个仅包含索引列的空数据表，也可以指定一部分初始字段。 - /// note - /// 首次调用请参考 [云文档接口快速入门](https://open.feishu.cn/document/ukTMukTMukTM/uczNzUjL3czM14yN3MTN)[多维表格接口接入指南](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bitable/notification) + /// 新增一个数据表，默认仅包含索引列，也可以指定一部分初始字段。 /// 权限要求： /// base:table:create /// bitable:app @@ -5585,7 +5607,7 @@ System.Threading.Tasks.Task PostBitableV1AppsByAppTokenTablesBat /// /// 路径参数 /// 必填：是 - /// 多维表格的唯一标识符 [app_token 参数说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bitable/notification#8121eebe) + /// 目标多维表格 App 的唯一标识。不同形态的多维表格，其 app_token 的获取方式不同，参考[多维表格 app_token 获取方式](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/bitable-overview)获取。 /// 示例值：appbcbWCzen6D8dezhoCH2RpMAh /// /// 请求体 @@ -5613,7 +5635,7 @@ System.Threading.Tasks.Task PostBitableV1AppsByAppTokenTablesBat /// /// 路径参数 /// 必填：是 - /// 多维表格的唯一标识符 [app_token 参数说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bitable/notification#8121eebe) + /// 目标多维表格 App 的唯一标识。不同形态的多维表格，其 app_token 的获取方式不同，参考[多维表格 app_token 获取方式](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/bitable-overview)获取。 /// 示例值：appbcbWCzen6D8dezhoCH2RpMAh /// /// @@ -5641,9 +5663,7 @@ System.Threading.Tasks.Task PostBitableV1AppsByAppTokenTablesBat /// 接口ID：6960166873968574467 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app/get /// Authorization：tenant_access_token、user_access_token - /// 获取指定多维表格的元数据信息，包括多维表格名称，多维表格版本号，多维表格是否开启高级权限等。 - /// note - /// 首次调用请参考 [云文档接口快速入门](https://open.feishu.cn/document/ukTMukTMukTM/uczNzUjL3czM14yN3MTN)[多维表格接口接入指南](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bitable/notification) + /// 获取指定多维表格的元数据信息，包括多维表格名称、多维表格版本号、多维表格是否开启高级权限等。 /// 权限要求： /// base:app:read /// bitable:app @@ -5653,7 +5673,7 @@ System.Threading.Tasks.Task PostBitableV1AppsByAppTokenTablesBat /// /// 路径参数 /// 必填：是 - /// 多维表格的唯一标识符 [app_token 参数说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bitable/notification#8121eebe) + /// 目标多维表格 App 的唯一标识。不同形态的多维表格，其 app_token 的获取方式不同，参考[多维表格 app_token 获取方式](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/bitable-overview)获取。 /// 示例值：appbcbWCzen6D8dezhoCH2RpMAh /// /// 用户凭证 @@ -10332,7 +10352,7 @@ System.Threading.Tasks.Task PostImV1ChatsByChatIdTopNoticeDelete /// 接口ID：7047048928294174722 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/image/upload /// Authorization：tenant_access_token、user_access_token - /// 上传进展记录图片。 + /// 上传进展记录图片。成功调用该接口后，你可继续调用[创建 OKR 进展记录](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/progress_record/create)或[更新 OKR 进展记录](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/progress_record/update)，将返回的 `url`参数和`file_token` 参数传入 `imageList` 参数中。 /// 权限要求： /// okr:okr /// @@ -10485,7 +10505,7 @@ System.Threading.Tasks.Task DeleteOkrV1ProgressRecordsByProgress /// 接口ID：7047733935745007620 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app/create /// Authorization：tenant_access_token、user_access_token - /// 在指定目录下创建多维表格 + /// 在指定文件夹中创建一个多维表格，包含一个空白的数据表。 /// 权限要求： /// base:app:create /// bitable:app @@ -11010,15 +11030,20 @@ System.Threading.Tasks.Task DeleteOkrV1ProgressRecordsByProgress /// 接口ID：7073673019918811164 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app/update /// Authorization：tenant_access_token、user_access_token - /// 通过 app_token 更新多维表格元数据 + /// 更新多维表格元数据，包括多维表格的名称、是否开启高级权限。 + /// ## 注意事项 + /// - 在线文档和电子表格中嵌入的多维表格、知识库中的多维表格不支持开启高级权限。 + /// - 此接口非原子操作，先修改多维表格名称，后开关高级权限，可能存在部分成功的情况。 /// 权限要求： + /// base:app:update /// bitable:app /// /// /// /// 路径参数 /// 必填：是 - /// Base app token + /// 目标多维表格的 App token。该接口仅支持存储在云空间文件夹中的多维表格，即 URL 以 **feishu.cn/base** 开头的多维表格形态。该类多维表格的 app_token 为 URL 下图高亮部分： + /// ![](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/6916f8cfac4045ba6585b90e3afdfb0a_sTn7sVvhOB.png?height=766&lazyload=true&maxWidth=700&width=3004) /// 示例值：appbcbWCzen6D8dezhoCH2RpMAh /// /// 请求体 @@ -13803,19 +13828,21 @@ System.Threading.Tasks.Task DeleteDriveV1FilesByFileTokenVersion /// note /// 首次调用请参考 [云文档接口快速入门](https://open.feishu.cn/document/ukTMukTMukTM/uczNzUjL3czM14yN3MTN)[多维表格接口接入指南](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bitable/notification) /// 权限要求： + /// base:table:update /// bitable:app /// /// /// /// 路径参数 /// 必填：是 - /// 多维表格的唯一标识符 [app_token 参数说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bitable/notification#8121eebe) + /// 目标多维表格 App 的唯一标识。不同形态的多维表格，其 app_token 的获取方式不同，参考[多维表格 app_token 获取方式](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/bitable-overview)获取。 /// 示例值：XrgTb4y1haKYnasu0xXb1g7lcSg /// /// /// 路径参数 /// 必填：是 - /// 多维表格数据表的唯一标识符 [table_id 参数说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bitable/notification#735fe883) + /// 多维表格数据表的唯一标识。你可通过多维表格 URL 获取 `table_id`，下图高亮部分即为当前数据表的 `table_id`。你也可通过[列出数据表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/list)接口获取 `table_id`。 + /// ![](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/18741fe2a0d3cafafaf9949b263bb57d_yD1wkOrSju.png?height=746&lazyload=true&maxWidth=700&width=2976) /// 示例值：tbl1TkhyTWDkSoZ3 /// /// 请求体 @@ -14331,6 +14358,8 @@ System.Threading.Tasks.Task PostMailV1UserMailboxesByUserMailbox /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app/copy /// Authorization：tenant_access_token、user_access_token /// 复制一个多维表格，可以指定复制到某个有权限的文件夹下。 + /// ## 前提条件 + /// 调用此接口前，请确保当前调用身份（tenant_access_token 或 user_access_token）已有多维表格和目标文件夹的阅读、编辑等文档权限，否则接口将返回 HTTP 403 或 400 状态码。了解更多，参考[如何为应用或用户开通云文档权限](https://open.feishu.cn/document/ukTMukTMukTM/uczNzUjL3czM14yN3MTN#16c6475a)。 /// 权限要求： /// base:app:copy /// bitable:app @@ -14339,8 +14368,8 @@ System.Threading.Tasks.Task PostMailV1UserMailboxesByUserMailbox /// /// 路径参数 /// 必填：是 - /// [多维表格 App token](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bitable/notification#8121eebe) - /// 示例值：S404b*****e9PQsYDWYcNryFn0g + /// 要复制的多维表格 App 的唯一标识。不同形态的多维表格，其 app_token 的获取方式不同，参考[多维表格 app_token 获取方式](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/bitable-overview)获取。 + /// 示例值：AW3Qbtr2cakCnesXzXVbbsrIcVT /// /// 请求体 /// 用户凭证 @@ -17868,19 +17897,20 @@ System.Threading.Tasks.Task DeleteTaskV2AttachmentsByAttachmentG /// /// 路径参数 /// 必填：是 - /// 多维表格的唯一标识 token。获取方式： + /// 多维表格 App 的唯一标识。不同形态的多维表格，其 app_token 的获取方式不同： /// - 如果多维表格的 URL 以 ==**feishu.cn/base**== 开头，该多维表格的 app_token 是下图高亮部分： /// ![app_token.png](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/6916f8cfac4045ba6585b90e3afdfb0a_GxbfkJHZBa.png?height=766&lazyload=true&width=3004) - /// - 如果多维表格的 URL 以 ==**feishu.cn/wiki**== 开头，你需调用知识库相关[获取知识空间节点信息](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space/get_node)接口获取多维表格的 app_token。当 obj_type 的值为 bitable 时，obj_token 字段的值才是多维表格的 app_token。了解更多，参考[多维表格接入指南](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bitable/notification#8121eebe)。 + /// - 如果多维表格的 URL 以 ==**feishu.cn/wiki**== 开头，你需调用知识库相关[获取知识空间节点信息](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space/get_node)接口获取多维表格的 app_token。当 obj_type 的值为 bitable 时，obj_token 字段的值才是多维表格的 app_token。 + /// 了解更多，参考[多维表格 app_token 获取方式](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/bitable-overview#-752212c)。 /// 示例值：NQRxbRkBMa6OnZsjtERcxhNWnNh /// /// /// 路径参数 /// 必填：是 - /// 多维表格的数据表 ID。获取方式： - /// - 在多维表格的 URL 地址栏中，table_id 是下图中高亮部分： - /// ![table_id.png](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/18741fe2a0d3cafafaf9949b263bb57d_JD4VlW56qA.png?height=746&lazyload=true&width=2976) - /// - 对于其它场景的多维表格，如在云文档中嵌入的多维表格，则需要通过[列出数据表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/list)接口获取 + /// 多维表格数据表的唯一标识。获取方式： + /// - 你可通过多维表格 URL 获取 `table_id`，下图高亮部分即为当前数据表的 `table_id` + /// - 也可通过[列出数据表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/list)接口获取 `table_id` + /// ![](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/18741fe2a0d3cafafaf9949b263bb57d_yD1wkOrSju.png?height=746&lazyload=true&maxWidth=700&width=2976) /// 示例值：tbl0xe5g8PP3U3cS /// /// @@ -18497,8 +18527,12 @@ System.Threading.Tasks.Task DeleteAcsV1VisitorsByVisitorIdAsync( /// 【智能伙伴创建平台】获取消息 /// 接口ID：7358047310868152324 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session-aily_message/get - /// Authorization：user_access_token + /// Authorization：tenant_access_token、user_access_token /// 该 API 用于获取某个飞书智能伙伴应用的消息（Message）的详细信息；包括消息的内容、发送人等。 + /// ## 实体概念说明 + /// - **会话**（Session）：管理用户与 Aily 助手之间的交互会话；每次会话记录了用户发送给 Aily 助手的消息以及 Aily 助手的响应。 + /// - **消息**（Message）：消息可以包含文本、表格、图片等多种类型的内容。 + /// - **运行**（Run）：Aily 助手基于会话内消息进行意图判定、调用匹配的技能，并返回技能执行后的结果消息。 /// 权限要求： /// aily:message:read /// @@ -18506,7 +18540,7 @@ System.Threading.Tasks.Task DeleteAcsV1VisitorsByVisitorIdAsync( /// /// 路径参数 /// 必填：是 - /// 会话 ID + /// 会话 ID；参考 [创建会话](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/app-session/create) 接口 /// 示例值：session_4dfunz7sp1g8m /// /// @@ -18526,8 +18560,12 @@ System.Threading.Tasks.Task DeleteAcsV1VisitorsByVisitorIdAsync( /// 【智能伙伴创建平台】列出消息 /// 接口ID：7358047310868168708 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session-aily_message/list - /// Authorization：user_access_token + /// Authorization：tenant_access_token、user_access_token /// 该 API 用于列出某个飞书智能伙伴应用的某个会话（Session）下消息（Message）的详细信息；包括消息的内容、发送人等。 + /// ## 实体概念说明 + /// - **会话**（Session）：管理用户与 Aily 助手之间的交互会话；每次会话记录了用户发送给 Aily 助手的消息以及 Aily 助手的响应。 + /// - **消息**（Message）：消息可以包含文本、表格、图片等多种类型的内容。 + /// - **运行**（Run）：Aily 助手基于会话内消息进行意图判定、调用匹配的技能，并返回技能执行后的结果消息。 /// 权限要求： /// aily:message:read /// @@ -18535,13 +18573,13 @@ System.Threading.Tasks.Task DeleteAcsV1VisitorsByVisitorIdAsync( /// /// 路径参数 /// 必填：是 - /// 会话 ID + /// 会话 ID；参考 [创建会话](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/app-session/create) 接口 /// 示例值：session_4dfunz7sp1g8m /// /// /// 必填：否 - /// 页面大小 - /// 示例值：10 + /// 本次请求获取的消息记录条数，默认 20 + /// 示例值：20 /// 默认值：10 /// /// @@ -18552,10 +18590,18 @@ System.Threading.Tasks.Task DeleteAcsV1VisitorsByVisitorIdAsync( /// /// /// 必填：否 - /// 运行 ID + /// 过滤条件，按执行的唯一 ID 筛选 /// 示例值：run_4dfrxvctjqzzj /// 默认值：null /// + /// + /// 必填：否 + /// 是否返回正在进行中（即流式输出中）的消息内容 + /// - 当设置为 `true` 时，返回的消息记录中、每个消息将额外包含一个 `status `字段（`IN_PROGRESS` | `COMPLETED`），此时 `content` 字段为当前时刻的消息内容 + /// - 当设置为 `false` 时，返回的消息记录仅包含已完成的消息 + /// 示例值：false + /// 默认值：null + /// /// 用户凭证 [HttpGet("/open-apis/aily/v1/sessions/{aily_session_id}/messages")] System.Threading.Tasks.Task> GetAilyV1SessionsByAilySessionIdMessagesAsync( @@ -18563,14 +18609,19 @@ System.Threading.Tasks.Task DeleteAcsV1VisitorsByVisitorIdAsync( [PathQuery] string aily_session_id, [PathQuery] int? page_size = 10, [PathQuery] string? page_token = null, - [PathQuery] string? run_id = null); + [PathQuery] string? run_id = null, + [PathQuery] bool? with_partial_message = null); /// /// 【智能伙伴创建平台】创建运行 /// 接口ID：7358047310868185092 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session-run/create - /// Authorization：user_access_token + /// Authorization：tenant_access_token、user_access_token /// 该 API 用于在某个飞书智能伙伴应用会话（Session）上创建一次运行（Run）。 + /// ## 实体概念说明 + /// - **会话**（Session）：管理用户与 Aily 助手之间的交互会话；每次会话记录了用户发送给 Aily 助手的消息以及 Aily 助手的响应。 + /// - **消息**（Message）：消息可以包含文本、表格、图片等多种类型的内容。 + /// - **运行**（Run）：Aily 助手基于会话内消息进行意图判定、调用匹配的技能，并返回技能执行后的结果消息。 /// 权限要求： /// aily:run:write /// @@ -18578,7 +18629,7 @@ System.Threading.Tasks.Task DeleteAcsV1VisitorsByVisitorIdAsync( /// /// 路径参数 /// 必填：是 - /// 会话 ID + /// 会话 ID；参考 [创建会话](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/app-session/create) 接口 /// 示例值：session_4dfunz7sp1g8m /// /// 请求体 @@ -18593,8 +18644,12 @@ System.Threading.Tasks.Task DeleteAcsV1VisitorsByVisitorIdAsync( /// 【智能伙伴创建平台】列出运行 /// 接口ID：7358047310868201476 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session-run/list - /// Authorization：user_access_token + /// Authorization：tenant_access_token、user_access_token /// 该 API 用于列出某个飞书智能伙伴应用的运行（Run）的详细信息；包括状态、结束时间等。 + /// ## 实体概念说明 + /// - **会话**（Session）：管理用户与 Aily 助手之间的交互会话；每次会话记录了用户发送给 Aily 助手的消息以及 Aily 助手的响应。 + /// - **消息**（Message）：消息可以包含文本、表格、图片等多种类型的内容。 + /// - **运行**（Run）：Aily 助手基于会话内消息进行意图判定、调用匹配的技能，并返回技能执行后的结果消息。 /// 权限要求： /// aily:run:read /// @@ -18602,13 +18657,13 @@ System.Threading.Tasks.Task DeleteAcsV1VisitorsByVisitorIdAsync( /// /// 路径参数 /// 必填：是 - /// 会话 ID + /// 会话 ID；参考 [创建会话](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/app-session/create) 接口 /// 示例值：session_4dfunz7sp1g8m /// /// /// 必填：否 - /// 页面大小 - /// 示例值：10 + /// 本次请求获取的运行记录条数，默认 20 + /// 示例值：20 /// 默认值：10 /// /// @@ -18629,8 +18684,12 @@ System.Threading.Tasks.Task DeleteAcsV1VisitorsByVisitorIdAsync( /// 【智能伙伴创建平台】取消运行 /// 接口ID：7358047310868217860 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session-run/cancel - /// Authorization：user_access_token - /// 该 API 用于取消某个飞书智能伙伴应用的运行（Run）。 + /// Authorization：tenant_access_token、user_access_token + /// 该 API 用于中止某个飞书智能伙伴的一次运行。 + /// ## 实体概念说明 + /// - **会话**（Session）：管理用户与 Aily 助手之间的交互会话；每次会话记录了用户发送给 Aily 助手的消息以及 Aily 助手的响应。 + /// - **消息**（Message）：消息可以包含文本、表格、图片等多种类型的内容。 + /// - **运行**（Run）：Aily 助手基于会话内消息进行意图判定、调用匹配的技能，并返回技能执行后的结果消息。 /// 权限要求： /// aily:run:write /// @@ -18638,13 +18697,13 @@ System.Threading.Tasks.Task DeleteAcsV1VisitorsByVisitorIdAsync( /// /// 路径参数 /// 必填：是 - /// 会话 ID + /// 会话 ID；参考 [创建会话](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/app-session/create) 接口 /// 示例值：session_4dfunz7sp1g8m /// /// /// 路径参数 /// 必填：是 - /// 运行 ID + /// 运行的唯一 ID /// 示例值：run_4dfrxvctjqzzj /// /// 用户凭证 @@ -18658,7 +18717,7 @@ System.Threading.Tasks.Task DeleteAcsV1VisitorsByVisitorIdAsync( /// 【智能伙伴创建平台】更新会话 /// 接口ID：7358047310868234244 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session/update - /// Authorization：user_access_token + /// Authorization：tenant_access_token、user_access_token /// 该 API 用于更新与某个飞书智能伙伴应用的一次会话（Session）的信息。 /// 权限要求： /// aily:session:write @@ -18682,7 +18741,7 @@ System.Threading.Tasks.Task DeleteAcsV1VisitorsByVisitorIdAsync( /// 【智能伙伴创建平台】获取会话 /// 接口ID：7358047310868250628 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session/get - /// Authorization：user_access_token + /// Authorization：tenant_access_token、user_access_token /// 该 API 用于获取与某个飞书智能伙伴应用的一次会话（Session）的详细信息，包括会话的状态、渠道上下文、创建时间等。 /// 权限要求： /// aily:session:read @@ -18704,7 +18763,7 @@ System.Threading.Tasks.Task DeleteAcsV1VisitorsByVisitorIdAsync( /// 【智能伙伴创建平台】删除会话 /// 接口ID：7358047310868267012 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session/delete - /// Authorization：user_access_token + /// Authorization：tenant_access_token、user_access_token /// 该 API 用于删除与某个飞书智能伙伴应用的一次会话（Session）。 /// 权限要求： /// aily:session:write @@ -18726,8 +18785,12 @@ System.Threading.Tasks.Task DeleteAilyV1SessionsByAilySessionIdA /// 【智能伙伴创建平台】发送消息 /// 接口ID：7358047310868283396 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session-aily_message/create - /// Authorization：user_access_token + /// Authorization：tenant_access_token、user_access_token /// 该 API 用于向某个飞书智能伙伴应用发送一条消息（Message）；每个消息从属于一个活跃的会话（Session）。 + /// ## 实体概念说明 + /// - **会话**（Session）：管理用户与 Aily 助手之间的交互会话；每次会话记录了用户发送给 Aily 助手的消息以及 Aily 助手的响应。 + /// - **消息**（Message）：消息可以包含文本、表格、图片等多种类型的内容。 + /// - **运行**（Run）：Aily 助手基于会话内消息进行意图判定、调用匹配的技能，并返回技能执行后的结果消息。 /// 权限要求： /// aily:message:write /// @@ -18735,7 +18798,7 @@ System.Threading.Tasks.Task DeleteAilyV1SessionsByAilySessionIdA /// /// 路径参数 /// 必填：是 - /// 会话 ID + /// 会话 ID；参考 [创建会话](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/app-session/create) 接口 /// 示例值：session_4dfunz7sp1g8m /// /// 请求体 @@ -18750,8 +18813,12 @@ System.Threading.Tasks.Task DeleteAilyV1SessionsByAilySessionIdA /// 【智能伙伴创建平台】获取运行 /// 接口ID：7358047310868299780 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session-run/get - /// Authorization：user_access_token + /// Authorization：tenant_access_token、user_access_token /// 该 API 用于获取某个飞书智能伙伴应用的运行（Run）的详细信息；包括运行的状态、结束时间等。 + /// ## 实体概念说明 + /// - **会话**（Session）：管理用户与 Aily 助手之间的交互会话；每次会话记录了用户发送给 Aily 助手的消息以及 Aily 助手的响应。 + /// - **消息**（Message）：消息可以包含文本、表格、图片等多种类型的内容。 + /// - **运行**（Run）：Aily 助手基于会话内消息进行意图判定、调用匹配的技能，并返回技能执行后的结果消息。 /// 权限要求： /// aily:run:read /// @@ -18759,13 +18826,13 @@ System.Threading.Tasks.Task DeleteAilyV1SessionsByAilySessionIdA /// /// 路径参数 /// 必填：是 - /// 会话 ID + /// 会话 ID；参考 [创建会话](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/app-session/create) 接口 /// 示例值：session_4dfunz7sp1g8m /// /// /// 路径参数 /// 必填：是 - /// 运行 ID + /// 运行的唯一 ID /// 示例值：run_4dfrxvctjqzzj /// /// 用户凭证 @@ -18779,8 +18846,12 @@ System.Threading.Tasks.Task DeleteAilyV1SessionsByAilySessionIdA /// 【智能伙伴创建平台】创建会话 /// 接口ID：7358047310868316164 /// 接口文档：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session/create - /// Authorization：user_access_token - /// 该 API 用于创建与某个飞书智能伙伴应用的一次会话（Session）；当创建会话成功后，可以发送消息、创建运行 + /// Authorization：tenant_access_token、user_access_token + /// 该 API 用于创建与某个飞书智能伙伴应用的一次会话（Session）；当创建会话成功后，可以发送消息、创建运行。 + /// ## 实体概念说明 + /// - **会话**（Session）：管理用户与 Aily 助手之间的交互会话；每次会话记录了用户发送给 Aily 助手的消息以及 Aily 助手的响应。 + /// - **消息**（Message）：消息可以包含文本、表格、图片等多种类型的内容。 + /// - **运行**（Run）：Aily 助手基于会话内消息进行意图判定、调用匹配的技能，并返回技能执行后的结果消息。 /// 权限要求： /// aily:session:write /// diff --git a/src/Okr/PostOkrV1ImagesUploadBodyDto.cs b/src/Okr/PostOkrV1ImagesUploadBodyDto.cs index 8e0c17f5..19a5aaf3 100644 --- a/src/Okr/PostOkrV1ImagesUploadBodyDto.cs +++ b/src/Okr/PostOkrV1ImagesUploadBodyDto.cs @@ -14,7 +14,7 @@ namespace FeishuNetSdk.Okr; /// /// 上传进展记录图片 请求体 -/// 上传进展记录图片。 +/// 上传进展记录图片。成功调用该接口后，你可继续调用[创建 OKR 进展记录](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/progress_record/create)或[更新 OKR 进展记录](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/progress_record/update)，将返回的 `url`参数和`file_token` 参数传入 `imageList` 参数中。 /// 接口ID：7047048928294174722 /// 文档地址：https://open.feishu.cn/document/server-docs/okr-v1/progress_record/upload /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fokr-v1%2fimage%2fupload @@ -26,7 +26,7 @@ public record PostOkrV1ImagesUploadBodyDto /// 必填：是 /// 示例值：6974586812998174252 /// - [System.Text.Json.Serialization.JsonPropertyName("target_id")] + [JsonPropertyName("target_id")] public string TargetId { get; set; } = string.Empty; /// @@ -38,6 +38,6 @@ public record PostOkrV1ImagesUploadBodyDto /// 3：okr的KR /// /// - [System.Text.Json.Serialization.JsonPropertyName("target_type")] + [JsonPropertyName("target_type")] public int TargetType { get; set; } } diff --git a/src/Okr/PostOkrV1ImagesUploadResponseDto.cs b/src/Okr/PostOkrV1ImagesUploadResponseDto.cs index 117b5fd8..68b04075 100644 --- a/src/Okr/PostOkrV1ImagesUploadResponseDto.cs +++ b/src/Okr/PostOkrV1ImagesUploadResponseDto.cs @@ -14,7 +14,7 @@ namespace FeishuNetSdk.Okr; /// /// 上传进展记录图片 响应体 -/// 上传进展记录图片。 +/// 上传进展记录图片。成功调用该接口后，你可继续调用[创建 OKR 进展记录](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/progress_record/create)或[更新 OKR 进展记录](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/progress_record/update)，将返回的 `url`参数和`file_token` 参数传入 `imageList` 参数中。 /// 接口ID：7047048928294174722 /// 文档地址：https://open.feishu.cn/document/server-docs/okr-v1/progress_record/upload /// JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fokr-v1%2fimage%2fupload diff --git a/src/Vc/PostVcV1RoomLevelsBodyDto.cs b/src/Vc/PostVcV1RoomLevelsBodyDto.cs index edd12942..1f0b60ae 100644 --- a/src/Vc/PostVcV1RoomLevelsBodyDto.cs +++ b/src/Vc/PostVcV1RoomLevelsBodyDto.cs @@ -31,7 +31,7 @@ public record PostVcV1RoomLevelsBodyDto /// /// 父层级ID。 - /// **说明**：如需在租户层级（即根层级）下创建会议室层级，可以先调用[查询会议室详情](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room/get)接口，将路径参数 `room_level_id` 传入 `0` 进行查询，返回结果中的 `room_level_id` 值即为根层级 ID。 + /// **说明**：如需在租户层级（即根层级）下创建会议室层级，可以先调用[查询会议室层级详情](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_level/get)接口，将路径参数 `room_level_id` 传入 `0` 进行查询，返回结果中的 `room_level_id` 值即为根层级 ID。 /// 必填：是 /// 示例值：omb_4ad1a2c7a2fbc5fc9570f38456931293 ///