From 039a9870392fe5b5e6f2e062c40936ac9da1ff63 Mon Sep 17 00:00:00 2001 From: "Vicente.Yu" <^@^> Date: Thu, 18 Jul 2024 00:45:20 +0800 Subject: [PATCH] =?UTF-8?q?=E6=96=B0=E5=A2=9E=20-=20=E3=80=90=E6=8B=9B?= =?UTF-8?q?=E8=81=98=E3=80=91=E6=96=B0=E5=BB=BA=E6=8B=9B=E8=81=98=E5=AE=98?= =?UTF-8?q?=E7=BD=91=E7=94=A8=E6=88=B7=20-=20=E3=80=90=E6=8B=9B=E8=81=98?= =?UTF-8?q?=E3=80=91=E8=8E=B7=E5=8F=96=E6=8B=9B=E8=81=98=E5=AE=98=E7=BD=91?= =?UTF-8?q?=E5=88=97=E8=A1=A8=20-=20=E3=80=90=E6=8B=9B=E8=81=98=E3=80=91?= =?UTF-8?q?=E8=81=8C=E4=BD=8D=E5=8F=91=E5=B8=83=E8=87=B3=E5=AE=98=E7=BD=91?= =?UTF-8?q?=20-=20=E3=80=90=E9=A3=9E=E4=B9=A6=E4=BA=BA=E4=BA=8B=EF=BC=88?= =?UTF-8?q?=E4=BC=81=E4=B8=9A=E7=89=88=EF=BC=89=E3=80=91=E5=8F=91=E8=B5=B7?= =?UTF-8?q?=E8=BD=AC=E6=AD=A3=20-=20=E3=80=90=E9=A3=9E=E4=B9=A6=E4=BA=BA?= =?UTF-8?q?=E4=BA=8B=EF=BC=88=E4=BC=81=E4=B8=9A=E7=89=88=EF=BC=89=E3=80=91?= =?UTF-8?q?=E6=92=A4=E9=94=80=E8=BD=AC=E6=AD=A3=20-=20=E3=80=90=E6=97=A5?= =?UTF-8?q?=E5=8E=86=E3=80=91=E5=88=9B=E5=BB=BA=E4=BC=9A=E8=AE=AE=E7=BA=AA?= =?UTF-8?q?=E8=A6=81=20-=20=E3=80=90=E9=A3=9E=E4=B9=A6=E4=BA=BA=E4=BA=8B?= =?UTF-8?q?=EF=BC=88=E4=BC=81=E4=B8=9A=E7=89=88=EF=BC=89=E3=80=91=E6=93=8D?= =?UTF-8?q?=E4=BD=9C=E5=91=98=E5=B7=A5=E5=AE=8C=E6=88=90=E5=85=A5=E8=81=8C?= =?UTF-8?q?=20-=20=E3=80=90=E9=A3=9E=E4=B9=A6=E4=BA=BA=E4=BA=8B=EF=BC=88?= =?UTF-8?q?=E4=BC=81=E4=B8=9A=E7=89=88=EF=BC=89=E3=80=91=E6=B5=81=E8=BD=AC?= =?UTF-8?q?=E5=85=A5=E8=81=8C=E4=BB=BB=E5=8A=A1=20-=20=E3=80=90=E9=A3=9E?= =?UTF-8?q?=E4=B9=A6=E4=BA=BA=E4=BA=8B=EF=BC=88=E4=BC=81=E4=B8=9A=E7=89=88?= =?UTF-8?q?=EF=BC=89=E3=80=91=E6=9F=A5=E8=AF=A2=E5=BE=85=E5=85=A5=E8=81=8C?= =?UTF-8?q?=E4=BF=A1=E6=81=AF?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 变更 - 查询打卡流水 响应体 - 批量查询打卡流水 响应体 - 查询打卡结果 响应体 - 修改保护范围 请求体 - 修改保护范围 响应体 - 更新下拉列表设置 响应体 - 搜索员工异动信息 响应体 - 发起员工异动 请求体 - 发起员工异动 响应体 - 【云文档】增加保护范围 - 【云文档】更新工作表属性 - 【云文档】操作工作表 - 【云文档】设置下拉列表 不推荐使用: - 【飞书人事】批量查询待入职信息 - 【飞书人事】查询单个待入职信息 Signed-off-by: Vicente.Yu <^@^> --- TenantAccessList.md | 260 +- UserAccessList.md | 100 +- ...RecognitionV1ImageBasicRecognizeBodyDto.cs | 4 +- ...gnitionV1ImageBasicRecognizeResponseDto.cs | 6 +- ...danceV1UserFlowsByUserFlowIdResponseDto.cs | 37 +- ...GetAttendanceV1UserSettingsQueryBodyDto.cs | 5 +- ...ttendanceV1UserSettingsQueryResponseDto.cs | 7 +- ...stAttendanceV1UserApprovalsQueryBodyDto.cs | 4 +- ...tendanceV1UserApprovalsQueryResponseDto.cs | 2 +- .../PostAttendanceV1UserFlowsQueryBodyDto.cs | 17 +- ...stAttendanceV1UserFlowsQueryResponseDto.cs | 47 +- ...AttendanceV1UserTaskRemedysQueryBodyDto.cs | 4 +- ...ndanceV1UserTaskRemedysQueryResponseDto.cs | 12 +- .../PostAttendanceV1UserTasksQueryBodyDto.cs | 26 +- ...stAttendanceV1UserTasksQueryResponseDto.cs | 66 +- src/Auth/GetAuthenV1UserInfoResponseDto.cs | 2 +- ...arIdEventsByEventIdAttendeesResponseDto.cs | 1 + ...sByCalendarIdEventsByEventIdResponseDto.cs | 1 + ...CalendarIdEventsInstanceViewResponseDto.cs | 1 + ...lendarIdEventsByEventIdAttendeesBodyDto.cs | 1 + ...arIdEventsByEventIdAttendeesResponseDto.cs | 1 + ...EventsByEventIdMeetingMinuteResponseDto.cs | 31 + ...BySpreadsheetTokenDataValidationBodyDto.cs | 20 +- ...readsheetTokenDataValidationResponseDto.cs | 23 +- ...readsheetTokenDataValidationResponseDto.cs | 54 +- ...tTokenProtectedRangeBatchGetResponseDto.cs | 37 +- ...BySpreadsheetTokenDataValidationBodyDto.cs | 37 +- ...readsheetTokenDataValidationResponseDto.cs | 32 + ...readsheetTokenProtectedDimensionBodyDto.cs | 98 + ...sheetTokenProtectedDimensionResponseDto.cs | 102 + ...etTokenProtectedRangeBatchUpdateBodyDto.cs | 60 +- ...kenProtectedRangeBatchUpdateResponseDto.cs | 55 +- ...ationBySheetIdByDataValidationIdBodyDto.cs | 30 +- ...nBySheetIdByDataValidationIdResponseDto.cs | 51 +- ...tDriveV1FilesByFileTokenVersionsBodyDto.cs | 8 +- ...PatchCorehrV2PreHiresByPreHireIdBodyDto.cs | 20 +- .../PostCorehrV2EmployeesBatchGetBodyDto.cs | 4 +- ...ostCorehrV2EmployeesBatchGetResponseDto.cs | 52 +- ...orehrV2EmployeesJobDatasBatchGetBodyDto.cs | 12 +- ...rV2EmployeesJobDatasBatchGetResponseDto.cs | 53 +- ...stCorehrV2EmployeesJobDatasQueryBodyDto.cs | 9 +- ...rehrV2EmployeesJobDatasQueryResponseDto.cs | 36 +- .../PostCorehrV2EmployeesSearchBodyDto.cs | 2 + .../PostCorehrV2EmployeesSearchResponseDto.cs | 16 + .../PostCorehrV2JobChangesSearchBodyDto.cs | 28 +- ...PostCorehrV2JobChangesSearchResponseDto.cs | 200 +- src/Corehr/PostCorehrV2PreHiresBodyDto.cs | 35 +- ...2PreHiresByPreHireIdCompleteResponseDto.cs | 31 + ...V2PreHiresByPreHireIdTransitTaskBodyDto.cs | 31 + ...eHiresByPreHireIdTransitTaskResponseDto.cs | 31 + .../PostCorehrV2PreHiresQueryBodyDto.cs | 53 + .../PostCorehrV2PreHiresQueryResponseDto.cs | 5482 +++++++++++++++++ .../PostCorehrV2ProbationSearchBodyDto.cs | 22 +- .../PostCorehrV2ProbationSearchResponseDto.cs | 16 +- .../PostCorehrV2ProbationSubmitBodyDto.cs | 154 + .../PostCorehrV2ProbationSubmitResponseDto.cs | 297 + .../PostCorehrV2ProbationWithdrawBodyDto.cs | 31 + src/FeishuNetSdk.csproj | 2 +- ...tCorehrV1PreHiresByPreHireIdResponseDto.cs | 18 +- .../GetCorehrV1PreHiresResponseDto.cs | 16 +- .../PostCorehrV1JobChangesBodyDto.cs | 244 +- .../PostCorehrV1JobChangesResponseDto.cs | 280 +- ...ostCorehrV1OffboardingsQueryResponseDto.cs | 4 +- .../PostCorehrV1OffboardingsSearchBodyDto.cs | 18 +- ...stCorehrV1OffboardingsSearchResponseDto.cs | 8 +- .../PostCorehrV1OffboardingsSubmitBodyDto.cs | 2 +- ...stCorehrV1OffboardingsSubmitResponseDto.cs | 2 +- src/Hire/GetHireV1ResumeSourcesResponseDto.cs | 10 +- ...1WebsitesByWebsiteIdChannelsResponseDto.cs | 4 +- src/Hire/GetHireV1WebsitesResponseDto.cs | 106 + ...isementsByAdvertisementIdPublishBodyDto.cs | 31 + ...ireV1WebsitesByWebsiteIdChannelsBodyDto.cs | 4 +- ...1WebsitesByWebsiteIdChannelsResponseDto.cs | 4 +- ...reV1WebsitesByWebsiteIdSiteUsersBodyDto.cs | 63 + ...WebsitesByWebsiteIdSiteUsersResponseDto.cs | 84 + ...esByWebsiteIdChannelsByChannelIdBodyDto.cs | 4 +- ...WebsiteIdChannelsByChannelIdResponseDto.cs | 4 +- src/IFeishuTenantApi.cs | 702 ++- src/IFeishuUserApi.cs | 223 +- 79 files changed, 8868 insertions(+), 822 deletions(-) rename src/{Ai.Spec => Ai}/PostOpticalCharRecognitionV1ImageBasicRecognizeBodyDto.cs (92%) rename src/{Ai.Spec => Ai}/PostOpticalCharRecognitionV1ImageBasicRecognizeResponseDto.cs (91%) create mode 100644 src/Calendar/PostCalendarV4CalendarsByCalendarIdEventsByEventIdMeetingMinuteResponseDto.cs create mode 100644 src/Ccm.Spec/PostSheetsV2SpreadsheetsBySpreadsheetTokenDataValidationResponseDto.cs create mode 100644 src/Ccm.Spec/PostSheetsV2SpreadsheetsBySpreadsheetTokenProtectedDimensionBodyDto.cs create mode 100644 src/Ccm.Spec/PostSheetsV2SpreadsheetsBySpreadsheetTokenProtectedDimensionResponseDto.cs create mode 100644 src/Corehr/PostCorehrV2PreHiresByPreHireIdCompleteResponseDto.cs create mode 100644 src/Corehr/PostCorehrV2PreHiresByPreHireIdTransitTaskBodyDto.cs create mode 100644 src/Corehr/PostCorehrV2PreHiresByPreHireIdTransitTaskResponseDto.cs create mode 100644 src/Corehr/PostCorehrV2PreHiresQueryBodyDto.cs create mode 100644 src/Corehr/PostCorehrV2PreHiresQueryResponseDto.cs create mode 100644 src/Corehr/PostCorehrV2ProbationSubmitBodyDto.cs create mode 100644 src/Corehr/PostCorehrV2ProbationSubmitResponseDto.cs create mode 100644 src/Corehr/PostCorehrV2ProbationWithdrawBodyDto.cs create mode 100644 src/Hire/GetHireV1WebsitesResponseDto.cs create mode 100644 src/Hire/PostHireV1AdvertisementsByAdvertisementIdPublishBodyDto.cs create mode 100644 src/Hire/PostHireV1WebsitesByWebsiteIdSiteUsersBodyDto.cs create mode 100644 src/Hire/PostHireV1WebsitesByWebsiteIdSiteUsersResponseDto.cs diff --git a/TenantAccessList.md b/TenantAccessList.md index 373c77e5..83f69d0b 100644 --- a/TenantAccessList.md +++ b/TenantAccessList.md @@ -231,9 +231,9 @@ GetSheetsV3SpreadsheetsBySpreadsheetTokenSheetsBySheetId 1162024-06-19✓云文档获取工作表 GetSheetsV3SpreadsheetsBySpreadsheetTokenSheetsQuery -1172024-06-19✓云文档操作工作表 +1172024-07-16✓云文档操作工作表 PostSheetsV2SpreadsheetsBySpreadsheetTokenSheetsBatchUpdate -1182024-07-04✓云文档更新工作表属性 +1182024-07-16✓云文档更新工作表属性 PostSheetsV2SpreadsheetsBySpreadsheetTokenSheetsBatchUpdate2 1192024-06-19✓云文档增加行列 PostSheetsV2SpreadsheetsBySpreadsheetTokenDimensionRange @@ -305,23 +305,23 @@ PutSheetsV3SpreadsheetsBySpreadsheetTokenSheetsBySheetIdFilterViewsByFilterViewIdConditionsByConditionId 1532024-06-27✓云文档删除筛选条件 DeleteSheetsV3SpreadsheetsBySpreadsheetTokenSheetsBySheetIdFilterViewsByFilterViewIdConditionsByConditionId -1542024-01-15✓云文档增加保护范围 +1542024-07-16✓云文档增加保护范围 PostSheetsV2SpreadsheetsBySpreadsheetTokenProtectedDimension -1552024-01-15✓云文档获取保护范围 +1552024-07-16✓云文档获取保护范围 GetSheetsV2SpreadsheetsBySpreadsheetTokenProtectedRangeBatchGet -1562022-03-03✓云文档修改保护范围 +1562024-07-16✓云文档修改保护范围 PostSheetsV2SpreadsheetsBySpreadsheetTokenProtectedRangeBatchUpdate -1572022-03-03✓云文档删除保护范围 +1572024-07-16✓云文档删除保护范围 DeleteSheetsV2SpreadsheetsBySpreadsheetTokenProtectedRangeBatchDel 1582024-07-05✓通讯录删除部门 DeleteContactV3DepartmentsByDepartmentId -1592023-07-13✓云文档查询下拉列表设置 +1592024-07-16✓云文档查询下拉列表设置 GetSheetsV2SpreadsheetsBySpreadsheetTokenDataValidation -1602022-03-03✓云文档设置下拉列表 +1602024-07-16✓云文档设置下拉列表 PostSheetsV2SpreadsheetsBySpreadsheetTokenDataValidation -1612022-03-03✓云文档更新下拉列表设置 +1612024-07-16✓云文档更新下拉列表设置 PutSheetsV2SpreadsheetsBySpreadsheetTokenDataValidationBySheetIdByDataValidationId -1622022-03-03✓云文档删除下拉列表设置 +1622024-07-16✓云文档删除下拉列表设置 DeleteSheetsV2SpreadsheetsBySpreadsheetTokenDataValidation 1632022-03-03✓云文档获取条件格式 GetSheetsV2SpreadsheetsBySpreadsheetTokenConditionFormats @@ -465,57 +465,57 @@ PostWikiV2SpacesBySpaceIdNodesMoveDocsToWiki 2332023-07-27✓云文档获取任务结果 GetWikiV2TasksByTaskId -2342024-06-14✓日历创建共享日历 +2342024-07-16✓日历创建共享日历 PostCalendarV4Calendars -2352024-06-14✓日历删除共享日历 +2352024-07-16✓日历删除共享日历 DeleteCalendarV4CalendarsByCalendarId 2362024-07-05✓通讯录获取父部门信息 GetContactV3DepartmentsParent -2372024-06-14✓日历查询主日历信息 +2372024-07-16✓日历查询主日历信息 PostCalendarV4CalendarsPrimary -2382024-06-14✓日历查询主日历日程忙闲信息 +2382024-07-16✓日历查询主日历日程忙闲信息 PostCalendarV4FreebusyList -2392024-06-14✓日历查询日历信息 +2392024-07-16✓日历查询日历信息 GetCalendarV4CalendarsByCalendarId -2402024-06-14✓日历查询日历列表 +2402024-07-16✓日历查询日历列表 GetCalendarV4Calendars -2412024-06-14✓日历更新日历信息 +2412024-07-16✓日历更新日历信息 PatchCalendarV4CalendarsByCalendarId -2422024-06-14✓日历搜索日历 +2422024-07-16✓日历搜索日历 PostCalendarV4CalendarsSearch -2432024-06-14✓日历订阅日历 +2432024-07-16✓日历订阅日历 PostCalendarV4CalendarsByCalendarIdSubscribe -2442024-06-14✓日历取消订阅日历 +2442024-07-16✓日历取消订阅日历 PostCalendarV4CalendarsByCalendarIdUnsubscribe -2452024-06-14✓日历创建访问控制 +2452024-07-16✓日历创建访问控制 PostCalendarV4CalendarsByCalendarIdAcls -2462024-06-14✓日历删除访问控制 +2462024-07-16✓日历删除访问控制 DeleteCalendarV4CalendarsByCalendarIdAclsByAclId 2472024-07-05✓通讯录更新部门 ID PatchContactV3DepartmentsByDepartmentIdUpdateDepartmentId -2482024-06-14✓日历获取访问控制列表 +2482024-07-16✓日历获取访问控制列表 GetCalendarV4CalendarsByCalendarIdAcls -2492024-07-01✓日历创建日程 +2492024-07-16✓日历创建日程 PostCalendarV4CalendarsByCalendarIdEvents -2502024-07-01✓日历删除日程 +2502024-07-16✓日历删除日程 DeleteCalendarV4CalendarsByCalendarIdEventsByEventId -2512024-07-01✓日历更新日程 +2512024-07-16✓日历更新日程 PatchCalendarV4CalendarsByCalendarIdEventsByEventId -2522024-07-01✓日历获取日程 +2522024-07-16✓日历获取日程 GetCalendarV4CalendarsByCalendarIdEventsByEventId -2532024-07-01✓日历获取日程列表 +2532024-07-16✓日历获取日程列表 GetCalendarV4CalendarsByCalendarIdEvents -2542024-07-01✓日历搜索日程 +2542024-07-16✓日历搜索日程 PostCalendarV4CalendarsByCalendarIdEventsSearch -2552024-07-01✓日历解绑会议群 +2552024-07-16✓日历解绑会议群 DeleteCalendarV4CalendarsByCalendarIdEventsByEventIdMeetingChat -2562024-07-01✓日历创建会议群 +2562024-07-16✓日历创建会议群 PostCalendarV4CalendarsByCalendarIdEventsByEventIdMeetingChat -2572024-07-01✓日历创建请假日程 +2572024-07-16✓日历创建请假日程 PostCalendarV4TimeoffEvents 2582024-07-05✓通讯录创建单位 PostContactV3Unit -2592024-07-01✓日历删除请假日程 +2592024-07-16✓日历删除请假日程 DeleteCalendarV4TimeoffEventsByTimeoffEventId 2602024-04-10✓会议室查询会议室日程主题和会议详情 PostMeetingRoomSummaryBatchGet @@ -523,13 +523,13 @@ GetMeetingRoomFreebusyBatchGet 2622024-04-30✓会议室回复会议室日程实例 PostMeetingRoomInstanceReply -2632024-07-01✓日历添加日程参与人 +2632024-07-16✓日历添加日程参与人 PostCalendarV4CalendarsByCalendarIdEventsByEventIdAttendees -2642024-07-01✓日历删除日程参与人 +2642024-07-16✓日历删除日程参与人 PostCalendarV4CalendarsByCalendarIdEventsByEventIdAttendeesBatchDelete -2652024-07-01✓日历获取日程参与人列表 +2652024-07-16✓日历获取日程参与人列表 GetCalendarV4CalendarsByCalendarIdEventsByEventIdAttendees -2662024-07-01✓日历获取日程参与群成员列表 +2662024-07-16✓日历获取日程参与群成员列表 GetCalendarV4CalendarsByCalendarIdEventsByEventIdAttendeesByAttendeeIdChatMembers 2672024-05-20✓视频会议预约会议 PostVcV1ReservesApply @@ -649,15 +649,15 @@ GetContactV3UnitByUnitId 3252024-07-08✓考勤打卡删除考勤组 DeleteAttendanceV1GroupsByGroupId -3262024-07-12✓考勤打卡按 ID 查询考勤组 +3262024-07-16✓考勤打卡按 ID 查询考勤组 GetAttendanceV1GroupsByGroupId 3272024-07-08✓考勤打卡按名称查询考勤组 PostAttendanceV1GroupsSearch 3282024-07-10✓考勤打卡查询所有考勤组 GetAttendanceV1Groups -3292024-07-15✓考勤打卡创建或修改排班表 +3292024-07-16✓考勤打卡创建或修改排班表 PostAttendanceV1UserDailyShiftsBatchCreate -3302024-07-15✓考勤打卡查询排班表 +3302024-07-16✓考勤打卡查询排班表 PostAttendanceV1UserDailyShiftsQuery 3312023-09-11✓考勤打卡更新统计设置 PutAttendanceV1UserStatsViewsByUserStatsViewId @@ -665,15 +665,15 @@ PostAttendanceV1UserStatsFieldsQuery 3332023-09-11✓考勤打卡查询统计设置 PostAttendanceV1UserStatsViewsQuery -3342024-07-12✓考勤打卡查询统计数据 +3342024-07-16✓考勤打卡查询统计数据 PostAttendanceV1UserStatsDatasQuery 3352024-07-05✓通讯录删除用户 DeleteContactV3UsersByUserId 3362024-07-05✓通讯录获取单位列表 GetContactV3Unit -3372024-07-12✓考勤打卡获取审批通过数据 +3372024-07-16✓考勤打卡获取审批通过数据 PostAttendanceV1UserApprovalsQuery -3382024-07-12✓考勤打卡写入审批结果 +3382024-07-16✓考勤打卡写入审批结果 PostAttendanceV1UserApprovals 3392024-07-10✓考勤打卡通知审批状态更新 PostAttendanceV1ApprovalInfosProcess @@ -681,21 +681,21 @@ PostAttendanceV1UserTaskRemedys 3412024-07-08✓考勤打卡获取可补卡时间 PostAttendanceV1UserTaskRemedysQueryUserAllowedRemedys -3422024-07-08✓考勤打卡获取补卡记录 +3422024-07-16✓考勤打卡获取补卡记录 PostAttendanceV1UserTaskRemedysQuery -3432024-07-11✓考勤打卡导入打卡流水 +3432024-07-16✓考勤打卡导入打卡流水 PostAttendanceV1UserFlowsBatchCreate -3442024-07-08✓考勤打卡查询打卡流水 +3442024-07-16✓考勤打卡查询打卡流水 GetAttendanceV1UserFlowsByUserFlowId -3452024-06-12✓考勤打卡批量查询打卡流水 +3452024-07-16✓考勤打卡批量查询打卡流水 PostAttendanceV1UserFlowsQuery -3462024-07-08✓考勤打卡查询打卡结果 +3462024-07-16✓考勤打卡查询打卡结果 PostAttendanceV1UserTasksQuery 3472024-07-05✓通讯录添加用户组成员 PostContactV3GroupByGroupIdMemberAdd 3482023-09-11✓考勤打卡修改用户人脸识别信息 PostAttendanceV1UserSettingsModify -3492023-09-11✓考勤打卡批量查询用户人脸识别信息 +3492024-07-16✓考勤打卡批量查询用户人脸识别信息 GetAttendanceV1UserSettingsQuery 3502023-07-10✓考勤打卡上传用户人脸识别照片 PostAttendanceV1FilesUpload @@ -999,105 +999,105 @@ PostTaskV2CustomFieldsByCustomFieldGuidOptions 5002023-09-11✓任务更新自定义字段选项 PatchTaskV2CustomFieldsByCustomFieldGuidOptionsByOptionGuid -5012024-06-21✓邮箱创建邮件组 +5012024-07-18✓邮箱创建邮件组 PostMailV1Mailgroups 5022024-07-05✓通讯录删除职级 DeleteContactV3JobLevelsByJobLevelId -5032024-06-21✓邮箱删除邮件组 +5032024-07-18✓邮箱删除邮件组 DeleteMailV1MailgroupsByMailgroupId -5042024-06-21✓邮箱修改邮件组部分信息 +5042024-07-18✓邮箱修改邮件组部分信息 PatchMailV1MailgroupsByMailgroupId -5052024-06-21✓邮箱修改邮件组全部信息 +5052024-07-18✓邮箱修改邮件组全部信息 PutMailV1MailgroupsByMailgroupId -5062024-06-21✓邮箱查询指定邮件组 +5062024-07-18✓邮箱查询指定邮件组 GetMailV1MailgroupsByMailgroupId -5072024-06-21✓邮箱批量获取邮件组 +5072024-07-18✓邮箱批量获取邮件组 GetMailV1Mailgroups -5082024-06-21✓邮箱批量创建邮件组管理员 +5082024-07-18✓邮箱批量创建邮件组管理员 PostMailV1MailgroupsByMailgroupIdManagersBatchCreate -5092024-06-21✓邮箱批量删除邮件组管理员 +5092024-07-18✓邮箱批量删除邮件组管理员 PostMailV1MailgroupsByMailgroupIdManagersBatchDelete -5102024-06-21✓邮箱批量获取邮件组管理员 +5102024-07-18✓邮箱批量获取邮件组管理员 GetMailV1MailgroupsByMailgroupIdManagers -5112024-06-21✓邮箱创建邮件组成员 +5112024-07-18✓邮箱创建邮件组成员 PostMailV1MailgroupsByMailgroupIdMembers -5122024-06-21✓邮箱删除邮件组成员 +5122024-07-18✓邮箱删除邮件组成员 DeleteMailV1MailgroupsByMailgroupIdMembersByMemberId 5132024-07-05✓通讯录更新职级 PutContactV3JobLevelsByJobLevelId -5142024-06-21✓邮箱查询指定邮件组成员 +5142024-07-18✓邮箱查询指定邮件组成员 GetMailV1MailgroupsByMailgroupIdMembersByMemberId -5152024-06-21✓邮箱获取所有邮件组成员 +5152024-07-18✓邮箱获取所有邮件组成员 GetMailV1MailgroupsByMailgroupIdMembers -5162024-06-21✓邮箱批量创建邮件组成员 +5162024-07-18✓邮箱批量创建邮件组成员 PostMailV1MailgroupsByMailgroupIdMembersBatchCreate -5172024-06-21✓邮箱批量删除邮件组成员 +5172024-07-18✓邮箱批量删除邮件组成员 DeleteMailV1MailgroupsByMailgroupIdMembersBatchDelete -5182024-06-21✓邮箱创建邮件组别名 +5182024-07-18✓邮箱创建邮件组别名 PostMailV1MailgroupsByMailgroupIdAliases -5192024-06-21✓邮箱删除邮件组别名 +5192024-07-18✓邮箱删除邮件组别名 DeleteMailV1MailgroupsByMailgroupIdAliasesByAliasId -5202024-06-21✓邮箱获取邮件组所有别名 +5202024-07-18✓邮箱获取邮件组所有别名 GetMailV1MailgroupsByMailgroupIdAliases -5212024-06-21✓邮箱创建邮件组权限成员 +5212024-07-18✓邮箱创建邮件组权限成员 PostMailV1MailgroupsByMailgroupIdPermissionMembers -5222024-06-21✓邮箱删除邮件组权限成员 +5222024-07-18✓邮箱删除邮件组权限成员 DeleteMailV1MailgroupsByMailgroupIdPermissionMembersByPermissionMemberId -5232024-06-21✓邮箱获取邮件组权限成员 +5232024-07-18✓邮箱获取邮件组权限成员 GetMailV1MailgroupsByMailgroupIdPermissionMembersByPermissionMemberId 5242024-07-05✓通讯录获取单个职级信息 GetContactV3JobLevelsByJobLevelId -5252024-06-21✓邮箱批量获取邮件组权限成员 +5252024-07-18✓邮箱批量获取邮件组权限成员 GetMailV1MailgroupsByMailgroupIdPermissionMembers -5262024-06-21✓邮箱批量创建邮件组权限成员 +5262024-07-18✓邮箱批量创建邮件组权限成员 PostMailV1MailgroupsByMailgroupIdPermissionMembersBatchCreate -5272024-06-21✓邮箱批量删除邮件组权限成员 +5272024-07-18✓邮箱批量删除邮件组权限成员 DeleteMailV1MailgroupsByMailgroupIdPermissionMembersBatchDelete -5282024-06-21✓邮箱创建公共邮箱 +5282024-07-18✓邮箱创建公共邮箱 PostMailV1PublicMailboxes -5292024-06-21✓邮箱修改公共邮箱部分信息 +5292024-07-18✓邮箱修改公共邮箱部分信息 PatchMailV1PublicMailboxesByPublicMailboxId -5302024-06-21✓邮箱修改公共邮箱全部信息 +5302024-07-18✓邮箱修改公共邮箱全部信息 PutMailV1PublicMailboxesByPublicMailboxId -5312024-06-21✓邮箱查询指定公共邮箱 +5312024-07-18✓邮箱查询指定公共邮箱 GetMailV1PublicMailboxesByPublicMailboxId -5322024-06-21✓邮箱查询所有公共邮箱 +5322024-07-18✓邮箱查询所有公共邮箱 GetMailV1PublicMailboxes -5332024-06-21✓邮箱永久删除公共邮箱 +5332024-07-18✓邮箱永久删除公共邮箱 DeleteMailV1PublicMailboxesByPublicMailboxId -5342024-06-21✓邮箱添加公共邮箱成员 +5342024-07-18✓邮箱添加公共邮箱成员 PostMailV1PublicMailboxesByPublicMailboxIdMembers 5352024-07-05✓通讯录获取租户职级列表 GetContactV3JobLevels -5362024-06-21✓邮箱删除公共邮箱单个成员 +5362024-07-18✓邮箱删除公共邮箱单个成员 DeleteMailV1PublicMailboxesByPublicMailboxIdMembersByMemberId -5372024-06-21✓邮箱删除公共邮箱所有成员 +5372024-07-18✓邮箱删除公共邮箱所有成员 PostMailV1PublicMailboxesByPublicMailboxIdMembersClear -5382024-06-21✓邮箱查询指定公共邮箱成员信息 +5382024-07-18✓邮箱查询指定公共邮箱成员信息 GetMailV1PublicMailboxesByPublicMailboxIdMembersByMemberId -5392024-06-21✓邮箱查询所有公共邮箱成员信息 +5392024-07-18✓邮箱查询所有公共邮箱成员信息 GetMailV1PublicMailboxesByPublicMailboxIdMembers -5402024-06-21✓邮箱批量添加公共邮箱成员 +5402024-07-18✓邮箱批量添加公共邮箱成员 PostMailV1PublicMailboxesByPublicMailboxIdMembersBatchCreate -5412024-06-21✓邮箱批量删除公共邮箱成员 +5412024-07-18✓邮箱批量删除公共邮箱成员 DeleteMailV1PublicMailboxesByPublicMailboxIdMembersBatchDelete -5422024-06-21✓邮箱创建公共邮箱别名 +5422024-07-18✓邮箱创建公共邮箱别名 PostMailV1PublicMailboxesByPublicMailboxIdAliases -5432024-06-21✓邮箱删除公共邮箱别名 +5432024-07-18✓邮箱删除公共邮箱别名 DeleteMailV1PublicMailboxesByPublicMailboxIdAliasesByAliasId -5442024-06-21✓邮箱查询公共邮箱的所有别名 +5442024-07-18✓邮箱查询公共邮箱的所有别名 GetMailV1PublicMailboxesByPublicMailboxIdAliases -5452024-06-21✓邮箱从回收站删除用户邮箱地址 +5452024-07-18✓邮箱从回收站删除用户邮箱地址 DeleteMailV1UserMailboxesByUserMailboxId 5462024-07-05✓通讯录创建序列 PostContactV3JobFamilies -5472024-06-21✓邮箱创建用户邮箱别名 +5472024-07-18✓邮箱创建用户邮箱别名 PostMailV1UserMailboxesByUserMailboxIdAliases -5482024-06-21✓邮箱删除用户邮箱别名 +5482024-07-18✓邮箱删除用户邮箱别名 DeleteMailV1UserMailboxesByUserMailboxIdAliasesByAliasId -5492024-06-21✓邮箱获取用户邮箱所有别名 +5492024-07-18✓邮箱获取用户邮箱所有别名 GetMailV1UserMailboxesByUserMailboxIdAliases -5502024-06-21✓邮箱查询邮箱地址状态 +5502024-07-18✓邮箱查询邮箱地址状态 PostMailV1UsersQuery 5512022-03-15✓应用信息校验应用管理员 GetApplicationV3IsUserAdmin @@ -1235,7 +1235,7 @@ PostDocumentAiV1ContractFieldExtraction 6182023-10-31✓AI 能力识别文件中的名片 PostDocumentAiV1BusinessCardRecognize -6192022-12-27✓AI 能力识别图片中的文字 +6192024-07-16✓AI 能力识别图片中的文字 PostOpticalCharRecognitionV1ImageBasicRecognize 6202024-01-03✓AI 能力识别语音文件 PostSpeechToTextV1SpeechFileRecognize @@ -1339,9 +1339,9 @@ PutImV1MessagesByMessageId 6702023-07-14✓飞书人事批量查询货币信息 GetCorehrV1Currencies -6712024-07-12✓飞书人事(企业版)批量查询员工信息 +6712024-07-17✓飞书人事(企业版)批量查询员工信息 PostCorehrV2EmployeesBatchGet -6722024-07-12✓飞书人事(企业版)搜索员工信息 +6722024-07-17✓飞书人事(企业版)搜索员工信息 PostCorehrV2EmployeesSearch 6732024-07-01✓飞书人事创建雇佣信息 PostCorehrV1Employments @@ -1369,9 +1369,9 @@ PatchCorehrV1JobDatasByJobDataId 6852024-07-08✓飞书人事查询单个任职信息 GetCorehrV1JobDatasByJobDataId -6862024-07-10✓飞书人事(企业版)获取任职信息列表 +6862024-07-17✓飞书人事(企业版)获取任职信息列表 PostCorehrV2EmployeesJobDatasQuery -6872024-07-10✓飞书人事(企业版)批量查询员工任职信息 +6872024-07-17✓飞书人事(企业版)批量查询员工任职信息 PostCorehrV2EmployeesJobDatasBatchGet 6882024-07-08✓飞书人事批量查询任职信息 GetCorehrV1JobDatas @@ -1455,15 +1455,15 @@ GetCorehrV1JobsByJobId 7282024-02-06✓飞书人事批量查询职务 GetCorehrV1Jobs -7292024-07-12✓飞书人事(企业版)直接创建待入职 +7292024-07-15✓飞书人事(企业版)直接创建待入职 PostCorehrV2PreHires 7302024-07-12✓飞书人事[不推荐] 更新待入职信息(不推荐) PatchCorehrV1PreHiresByPreHireId 7312024-07-12✓飞书人事删除待入职(不推荐) DeleteCorehrV1PreHiresByPreHireId -7322024-07-12✓飞书人事查询单个待入职信息 +7322024-07-15✓飞书人事[不推荐] 查询单个待入职信息 GetCorehrV1PreHiresByPreHireId -7332024-07-12✓飞书人事批量查询待入职信息 +7332024-07-15✓飞书人事[不推荐] 批量查询待入职信息 GetCorehrV1PreHires 7342024-06-07✓飞书人事(企业版)搜索合同 PostCorehrV2ContractsSearch @@ -1479,7 +1479,7 @@ GetCorehrV1ContractsByContractId 7402024-06-07✓飞书人事批量查询合同 GetCorehrV1Contracts -7412024-02-06✓飞书人事(企业版)搜索试用期信息 +7412024-07-15✓飞书人事(企业版)搜索试用期信息 PostCorehrV2ProbationSearch 7422024-02-06✓飞书人事(企业版)启用/停用试用期考核功能 PostCorehrV2ProbationEnableDisableAssessment @@ -1495,15 +1495,15 @@ GetCorehrV1TransferReasonsQuery 7482024-03-07✓飞书人事获取异动类型列表 GetCorehrV1TransferTypesQuery -7492024-03-07✓飞书人事发起员工异动 +7492024-07-15✓飞书人事发起员工异动 PostCorehrV1JobChanges -7502024-03-07✓飞书人事(企业版)搜索员工异动信息 +7502024-07-15✓飞书人事(企业版)搜索员工异动信息 PostCorehrV2JobChangesSearch -7512024-06-29✓飞书人事查询员工离职原因列表 +7512024-07-15✓飞书人事查询员工离职原因列表 PostCorehrV1OffboardingsQuery -7522024-07-03✓飞书人事操作员工离职 +7522024-07-15✓飞书人事操作员工离职 PostCorehrV1OffboardingsSubmit -7532024-07-03✓飞书人事搜索离职信息 +7532024-07-15✓飞书人事搜索离职信息 PostCorehrV1OffboardingsSearch 7542024-05-30✓飞书人事创建假期发放记录 PostCorehrV1LeaveGrantingRecords @@ -1625,7 +1625,7 @@ GetHireV1Offers 8132024-06-21✓消息与群组查询批量消息推送和阅读人数 GetImV1BatchMessagesByBatchMessageIdReadUser -8142024-07-11✓招聘更新 Offer 状态 +8142024-07-18✓招聘更新 Offer 状态 PatchHireV1OffersByOfferIdOfferStatus 8152024-07-11✓招聘更新实习 Offer 入/离职状态 PostHireV1OffersByOfferIdInternOfferStatus @@ -1649,7 +1649,7 @@ GetImV1BatchMessagesByBatchMessageIdGetProgress 8252024-07-10✓招聘获取备注列表 GetHireV1Notes -8262024-07-10✓招聘获取简历来源列表 +8262024-07-18✓招聘获取简历来源列表 GetHireV1ResumeSources 8272023-11-02✓招聘创建账号自定义字段 PostHireV1EcoAccountCustomFields @@ -1787,9 +1787,9 @@ GetLingoV1FilesByFileTokenDownload 8942024-04-26✓安全合规获取OpenAPI审计日志数据 PostSecurityAndComplianceV1OpenapiLogsListData -8952024-07-10✓妙记获取妙记统计数据 +8952024-07-18✓妙记获取妙记统计数据 GetMinutesV1MinutesByMinuteTokenStatistics -8962024-07-10✓妙记获取妙记信息 +8962024-07-18✓妙记获取妙记信息 GetMinutesV1MinutesByMinuteToken 8972023-06-29✓工作台获取工作台访问数据 PostWorkplaceV1WorkplaceAccessDataSearch @@ -2011,9 +2011,9 @@ PostCorehrV2BasicInfoDistrictsSearch 10062024-06-29✓飞书人事(企业版)查询货币信息 PostCorehrV2BasicInfoCurrenciesSearch -10072024-07-01✓日历回复日程 +10072024-07-16✓日历回复日程 PostCalendarV4CalendarsByCalendarIdEventsByEventIdReply -10082024-07-01✓日历获取重复日程实例 +10082024-07-16✓日历获取重复日程实例 GetCalendarV4CalendarsByCalendarIdEventsByEventIdInstances 10092024-01-03✓AI 能力识别文件中的机动车发票 PostDocumentAiV1VehicleInvoiceRecognize @@ -2049,7 +2049,7 @@ PatchOkrV1PeriodsByPeriodId 10252024-06-06✓消息与群组转发话题 PostImV1ThreadsByThreadIdForward -10262024-07-01✓日历查询日程视图 +10262024-07-16✓日历查询日程视图 GetCalendarV4CalendarsByCalendarIdEventsInstanceView 10272024-07-10✓招聘获取职位列表 GetHireV1Jobs @@ -2101,7 +2101,7 @@ PostImV2UrlPreviewsBatchUpdate 10512024-05-23✓飞书人事(企业版)查询指定生效日期的部门基本信息 PostCorehrV2DepartmentsQueryTimeline -10522024-07-11✓飞书人事(企业版)更新待入职信息 +10522024-07-15✓飞书人事(企业版)更新待入职信息 PatchCorehrV2PreHiresByPreHireId 10532024-07-11✓飞书人事(企业版)获取流程表单数据 GetCorehrV2ProcessesByProcessIdFormVariableData @@ -2135,7 +2135,7 @@ PostCorehrV2DepartmentsQueryMultiTimeline 10682024-05-29删除云文档搜索文件 PostSuiteDocsApiSearchObject -10692024-07-10✓飞书人事(企业版)添加人员 +10692024-07-17✓飞书人事(企业版)添加人员 PostCorehrV2Employees 10702024-07-10✓招聘获取角色详情 GetHireV1RolesByRoleId @@ -2201,13 +2201,13 @@ DeleteHireV1NotesByNoteId 11012024-07-10✓招聘获取角色列表 GetHireV1Roles -11022024-07-10✓招聘获取招聘官网推广渠道列表 +11022024-07-18✓招聘获取招聘官网推广渠道列表 GetHireV1WebsitesByWebsiteIdChannels -11032024-07-10✓招聘删除招聘官网推广渠道 +11032024-07-17✓招聘删除招聘官网推广渠道 DeleteHireV1WebsitesByWebsiteIdChannelsByChannelId -11042024-07-10✓招聘新建招聘官网推广渠道 +11042024-07-17✓招聘新建招聘官网推广渠道 PostHireV1WebsitesByWebsiteIdChannels -11052024-07-10✓招聘更新招聘官网推广渠道 +11052024-07-17✓招聘更新招聘官网推广渠道 PutHireV1WebsitesByWebsiteIdChannelsByChannelId 11062024-07-10✓消息与群组添加跟随气泡 PostImV1MessagesByMessageIdPushFollowUp @@ -2229,4 +2229,22 @@ GetPayrollV1CostAllocationReports 11152024-07-15新增Payroll批量查询成本分摊方案 GetPayrollV1CostAllocationPlans +11162024-07-17新增招聘新建招聘官网用户 +PostHireV1WebsitesByWebsiteIdSiteUsers +11172024-07-18新增招聘获取招聘官网列表 +GetHireV1Websites +11182024-07-15新增飞书人事(企业版)发起转正 +PostCorehrV2ProbationSubmit +11192024-07-15新增飞书人事(企业版)撤销转正 +PostCorehrV2ProbationWithdraw +11202024-07-16新增日历创建会议纪要 +PostCalendarV4CalendarsByCalendarIdEventsByEventIdMeetingMinute +11212024-07-15新增飞书人事(企业版)操作员工完成入职 +PostCorehrV2PreHiresByPreHireIdComplete +11222024-07-15新增飞书人事(企业版)流转入职任务 +PostCorehrV2PreHiresByPreHireIdTransitTask +11232024-07-15新增飞书人事(企业版)查询待入职信息 +PostCorehrV2PreHiresQuery +11242024-07-18新增招聘职位发布至官网 +PostHireV1AdvertisementsByAdvertisementIdPublish diff --git a/UserAccessList.md b/UserAccessList.md index 91561a66..8f181456 100644 --- a/UserAccessList.md +++ b/UserAccessList.md @@ -1,5 +1,5 @@ - + @@ -51,9 +51,9 @@ - + - + @@ -125,23 +125,23 @@ - + - + - + - + - + - + - + - + @@ -297,75 +297,75 @@ - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -707,7 +707,7 @@ - + @@ -763,9 +763,9 @@ - + - + @@ -965,9 +965,9 @@ - + - + @@ -985,7 +985,7 @@ - + @@ -1015,7 +1015,7 @@ - + @@ -1025,4 +1025,6 @@ + +
序号更新日期可用类别说明
12023-11-16身份验证获取登录用户信息
12024-07-16身份验证获取登录用户信息
GetAuthenV1UserInfo
22024-07-05通讯录修改用户部分信息
PatchContactV3UsersByUserId
GetContactV3JobTitles
262024-06-19云文档获取工作表
GetSheetsV3SpreadsheetsBySpreadsheetTokenSheetsQuery
272024-06-19云文档操作工作表
272024-07-16云文档操作工作表
PostSheetsV2SpreadsheetsBySpreadsheetTokenSheetsBatchUpdate
282024-07-04云文档更新工作表属性
282024-07-16云文档更新工作表属性
PostSheetsV2SpreadsheetsBySpreadsheetTokenSheetsBatchUpdate2
292024-06-19云文档增加行列
PostSheetsV2SpreadsheetsBySpreadsheetTokenDimensionRange
PutSheetsV3SpreadsheetsBySpreadsheetTokenSheetsBySheetIdFilterViewsByFilterViewIdConditionsByConditionId
632024-06-27云文档删除筛选条件
DeleteSheetsV3SpreadsheetsBySpreadsheetTokenSheetsBySheetIdFilterViewsByFilterViewIdConditionsByConditionId
642024-01-15云文档增加保护范围
642024-07-16云文档增加保护范围
PostSheetsV2SpreadsheetsBySpreadsheetTokenProtectedDimension
652024-01-15云文档获取保护范围
652024-07-16云文档获取保护范围
GetSheetsV2SpreadsheetsBySpreadsheetTokenProtectedRangeBatchGet
662022-03-03云文档修改保护范围
662024-07-16云文档修改保护范围
PostSheetsV2SpreadsheetsBySpreadsheetTokenProtectedRangeBatchUpdate
672022-03-03云文档删除保护范围
672024-07-16云文档删除保护范围
DeleteSheetsV2SpreadsheetsBySpreadsheetTokenProtectedRangeBatchDel
682023-07-13云文档查询下拉列表设置
682024-07-16云文档查询下拉列表设置
GetSheetsV2SpreadsheetsBySpreadsheetTokenDataValidation
692024-07-10消息与群组更新应用发送的消息卡片
PatchImV1MessagesByMessageId
702022-03-03云文档设置下拉列表
702024-07-16云文档设置下拉列表
PostSheetsV2SpreadsheetsBySpreadsheetTokenDataValidation
712022-03-03云文档更新下拉列表设置
712024-07-16云文档更新下拉列表设置
PutSheetsV2SpreadsheetsBySpreadsheetTokenDataValidationBySheetIdByDataValidationId
722022-03-03云文档删除下拉列表设置
722024-07-16云文档删除下拉列表设置
DeleteSheetsV2SpreadsheetsBySpreadsheetTokenDataValidation
732022-03-03云文档获取条件格式
GetSheetsV2SpreadsheetsBySpreadsheetTokenConditionFormats
PostDriveV1FilesByFileTokenSubscriptions
1492023-12-29云文档更新订阅状态
PatchDriveV1FilesByFileTokenSubscriptionsBySubscriptionId
1502024-06-14日历创建共享日历
1502024-07-16日历创建共享日历
PostCalendarV4Calendars
1512024-06-14日历删除共享日历
1512024-07-16日历删除共享日历
DeleteCalendarV4CalendarsByCalendarId
1522024-06-14日历查询主日历信息
1522024-07-16日历查询主日历信息
PostCalendarV4CalendarsPrimary
1532024-06-14日历查询主日历日程忙闲信息
1532024-07-16日历查询主日历日程忙闲信息
PostCalendarV4FreebusyList
1542024-06-14日历查询日历信息
1542024-07-16日历查询日历信息
GetCalendarV4CalendarsByCalendarId
1552024-06-14日历查询日历列表
1552024-07-16日历查询日历列表
GetCalendarV4Calendars
1562024-06-14日历更新日历信息
1562024-07-16日历更新日历信息
PatchCalendarV4CalendarsByCalendarId
1572024-06-14日历搜索日历
1572024-07-16日历搜索日历
PostCalendarV4CalendarsSearch
1582024-06-21消息与群组更新群信息
PutImV1ChatsByChatId
1592024-06-14日历订阅日历
1592024-07-16日历订阅日历
PostCalendarV4CalendarsByCalendarIdSubscribe
1602024-06-14日历取消订阅日历
1602024-07-16日历取消订阅日历
PostCalendarV4CalendarsByCalendarIdUnsubscribe
1612024-06-14日历订阅日历变更事件
1612024-07-16日历订阅日历变更事件
PostCalendarV4CalendarsSubscription
1622024-06-14日历取消订阅日历变更事件
1622024-07-16日历取消订阅日历变更事件
PostCalendarV4CalendarsUnsubscription
1632024-06-14日历创建访问控制
1632024-07-16日历创建访问控制
PostCalendarV4CalendarsByCalendarIdAcls
1642024-06-14日历删除访问控制
1642024-07-16日历删除访问控制
DeleteCalendarV4CalendarsByCalendarIdAclsByAclId
1652024-06-14日历获取访问控制列表
1652024-07-16日历获取访问控制列表
GetCalendarV4CalendarsByCalendarIdAcls
1662024-06-14日历订阅日历访问控制变更事件
1662024-07-16日历订阅日历访问控制变更事件
PostCalendarV4CalendarsByCalendarIdAclsSubscription
1672024-06-14日历取消订阅日历访问控制变更事件
1672024-07-16日历取消订阅日历访问控制变更事件
PostCalendarV4CalendarsByCalendarIdAclsUnsubscription
1682024-07-01日历创建日程
1682024-07-16日历创建日程
PostCalendarV4CalendarsByCalendarIdEvents
1692024-06-21消息与群组更新群发言权限
PutImV1ChatsByChatIdModeration
1702024-07-01日历删除日程
1702024-07-16日历删除日程
DeleteCalendarV4CalendarsByCalendarIdEventsByEventId
1712024-07-01日历更新日程
1712024-07-16日历更新日程
PatchCalendarV4CalendarsByCalendarIdEventsByEventId
1722024-07-01日历获取日程
1722024-07-16日历获取日程
GetCalendarV4CalendarsByCalendarIdEventsByEventId
1732024-07-01日历获取日程列表
1732024-07-16日历获取日程列表
GetCalendarV4CalendarsByCalendarIdEvents
1742024-07-01日历搜索日程
1742024-07-16日历搜索日程
PostCalendarV4CalendarsByCalendarIdEventsSearch
1752024-07-01日历订阅日程变更事件
1752024-07-16日历订阅日程变更事件
PostCalendarV4CalendarsByCalendarIdEventsSubscription
1762024-07-01日历取消订阅日程变更事件
1762024-07-16日历取消订阅日程变更事件
PostCalendarV4CalendarsByCalendarIdEventsUnsubscription
1772024-07-01日历解绑会议群
1772024-07-16日历解绑会议群
DeleteCalendarV4CalendarsByCalendarIdEventsByEventIdMeetingChat
1782024-07-01日历创建会议群
1782024-07-16日历创建会议群
PostCalendarV4CalendarsByCalendarIdEventsByEventIdMeetingChat
1792024-05-24会议室查询会议室忙闲
GetMeetingRoomFreebusyBatchGet
1802024-06-21消息与群组获取群信息
GetImV1ChatsByChatId
1812024-07-01日历添加日程参与人
1812024-07-16日历添加日程参与人
PostCalendarV4CalendarsByCalendarIdEventsByEventIdAttendees
1822024-07-01日历删除日程参与人
1822024-07-16日历删除日程参与人
PostCalendarV4CalendarsByCalendarIdEventsByEventIdAttendeesBatchDelete
1832024-07-01日历获取日程参与人列表
1832024-07-16日历获取日程参与人列表
GetCalendarV4CalendarsByCalendarIdEventsByEventIdAttendees
1842024-07-01日历获取日程参与群成员列表
1842024-07-16日历获取日程参与群成员列表
GetCalendarV4CalendarsByCalendarIdEventsByEventIdAttendeesByAttendeeIdChatMembers
1852024-07-10日历生成 CalDAV 配置
PostCalendarV4SettingsGenerateCaldavConf
PostTaskV2CustomFieldsByCustomFieldGuidOptions
3542023-09-11任务更新自定义字段选项
PatchTaskV2CustomFieldsByCustomFieldGuidOptionsByOptionGuid
3552024-06-21邮箱查询所有公共邮箱
3552024-07-18邮箱查询所有公共邮箱
GetMailV1PublicMailboxes
3562023-11-27搜索搜索消息
PostSearchV2Message
PostLingoV1FilesUpload
3822023-10-25词典下载图片
GetLingoV1FilesByFileTokenDownload
3832024-07-10妙记获取妙记统计数据
3832024-07-18妙记获取妙记统计数据
GetMinutesV1MinutesByMinuteTokenStatistics
3842024-07-10妙记获取妙记信息
3842024-07-18妙记获取妙记信息
GetMinutesV1MinutesByMinuteToken
3852023-04-07应用信息获取用户自定义常用的应用
GetApplicationV5ApplicationsFavourite
DeleteLingoV1EntitiesByEntityId
4832024-05-23飞书人事更新公司
PatchCorehrV1CompaniesByCompanyId
4842024-07-01日历回复日程
4842024-07-16日历回复日程
PostCalendarV4CalendarsByCalendarIdEventsByEventIdReply
4852024-07-01日历获取重复日程实例
4852024-07-16日历获取重复日程实例
GetCalendarV4CalendarsByCalendarIdEventsByEventIdInstances
4862024-01-03AI 能力识别文件中的机动车发票
PostDocumentAiV1VehicleInvoiceRecognize
PostAcsV1RuleExternal
4932024-01-09智能门禁删除访客
DeleteAcsV1VisitorsByVisitorId
4942024-07-01日历查询日程视图
4942024-07-16日历查询日程视图
GetCalendarV4CalendarsByCalendarIdEventsInstanceView
4952024-06-26多维表格查询记录
PostBitableV1AppsByAppTokenTablesByTableIdRecordsSearch
PostAilyV1Sessions
5082024-07-12薪酬管理批量查询员工薪资档案
PostCompensationV1ArchivesQuery
5092024-07-10飞书人事(企业版)添加人员
5092024-07-17飞书人事(企业版)添加人员
PostCorehrV2Employees
5102024-07-10绩效获取指标库信息
PostPerformanceV2MetricLibsQuery
PostPerformanceV2MetricFieldsQuery
5132024-07-02云文档批量增加协作者权限
PostDriveV1PermissionsByTokenMembersBatchCreate
5142024-07-16新增日历创建会议纪要
PostCalendarV4CalendarsByCalendarIdEventsByEventIdMeetingMinute
diff --git a/src/Ai.Spec/PostOpticalCharRecognitionV1ImageBasicRecognizeBodyDto.cs b/src/Ai/PostOpticalCharRecognitionV1ImageBasicRecognizeBodyDto.cs similarity index 92% rename from src/Ai.Spec/PostOpticalCharRecognitionV1ImageBasicRecognizeBodyDto.cs rename to src/Ai/PostOpticalCharRecognitionV1ImageBasicRecognizeBodyDto.cs index 16722844..1bb230e5 100644 --- a/src/Ai.Spec/PostOpticalCharRecognitionV1ImageBasicRecognizeBodyDto.cs +++ b/src/Ai/PostOpticalCharRecognitionV1ImageBasicRecognizeBodyDto.cs @@ -11,7 +11,7 @@ // // 识别图片中的文字 请求体 // ************************************************************************ -namespace FeishuNetSdk.Ai.Spec; +namespace FeishuNetSdk.Ai; /// /// 识别图片中的文字 请求体 /// 可识别图片中的文字,按图片中的区域划分,分段返回文本列表。 @@ -23,8 +23,8 @@ public record PostOpticalCharRecognitionV1ImageBasicRecognizeBodyDto { /// /// base64 后的图片数据 - /// **示例值**:"base64后的图片二进制数据" /// 必填:否 + /// 示例值:base64后的图片二进制数据 /// [JsonPropertyName("image")] public string? Image { get; set; } diff --git a/src/Ai.Spec/PostOpticalCharRecognitionV1ImageBasicRecognizeResponseDto.cs b/src/Ai/PostOpticalCharRecognitionV1ImageBasicRecognizeResponseDto.cs similarity index 91% rename from src/Ai.Spec/PostOpticalCharRecognitionV1ImageBasicRecognizeResponseDto.cs rename to src/Ai/PostOpticalCharRecognitionV1ImageBasicRecognizeResponseDto.cs index 708ae384..192e2b59 100644 --- a/src/Ai.Spec/PostOpticalCharRecognitionV1ImageBasicRecognizeResponseDto.cs +++ b/src/Ai/PostOpticalCharRecognitionV1ImageBasicRecognizeResponseDto.cs @@ -11,7 +11,7 @@ // // 识别图片中的文字 响应体 // ************************************************************************ -namespace FeishuNetSdk.Ai.Spec; +namespace FeishuNetSdk.Ai; /// /// 识别图片中的文字 响应体 /// 可识别图片中的文字,按图片中的区域划分,分段返回文本列表。 @@ -23,8 +23,8 @@ public record PostOpticalCharRecognitionV1ImageBasicRecognizeResponseDto { /// /// 按区域识别,返回文本列表 - /// 必填:否 + /// 必填:是 /// [JsonPropertyName("text_list")] - public string[]? TextList { get; set; } + public string[] TextList { get; set; } = Array.Empty(); } diff --git a/src/Attendance/GetAttendanceV1UserFlowsByUserFlowIdResponseDto.cs b/src/Attendance/GetAttendanceV1UserFlowsByUserFlowIdResponseDto.cs index 89e51535..5c7a9bad 100644 --- a/src/Attendance/GetAttendanceV1UserFlowsByUserFlowIdResponseDto.cs +++ b/src/Attendance/GetAttendanceV1UserFlowsByUserFlowIdResponseDto.cs @@ -4,7 +4,7 @@ // Created : 2024-06-24 // // Last Modified By : yxr -// Last Modified On : 2024-06-24 +// Last Modified On : 2024-07-18 // ************************************************************************ // // MIT @@ -14,7 +14,16 @@ namespace FeishuNetSdk.Attendance; /// /// 查询打卡流水 响应体 -/// 通过打卡记录 ID 获取用户的打卡流水记录。 +/// 通过打卡记录 ID 获取用户的打卡流水记录。返回信息主要包含: +/// * 用户id和创建者id +/// * 记录信息 +/// * 打卡位置信息、时间信息 +/// * 打卡方式信息 +/// * GPS 打卡:location_name(定位地址信息) +/// * Wi-Fi 打卡:ssid(wifi名称)、bssid(mac地址) +/// * 考勤机打卡:device_id(考勤机设备id) +/// * 打卡结果 +/// 对应页面功能打卡管理-[打卡记录](https://example.feishu.cn/people/workforce-management/manage/statistics/flow) /// 接口ID:7044467124773535745 /// 文档地址:https://open.feishu.cn/document/server-docs/attendance-v1/user_task/get /// JSON地址:https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fattendance-v1%2fuser_flow%2fget @@ -22,7 +31,7 @@ namespace FeishuNetSdk.Attendance; public record GetAttendanceV1UserFlowsByUserFlowIdResponseDto { /// - /// 用户 ID + /// 用户 ID,对应employee_type /// 必填:是 /// 示例值:abd754f7 /// @@ -30,7 +39,7 @@ public record GetAttendanceV1UserFlowsByUserFlowIdResponseDto public string UserId { get; set; } = string.Empty; /// - /// 记录创建者 ID + /// 记录创建者 ID,对应employee_type /// 必填:是 /// 示例值:abd754f7 /// @@ -62,9 +71,9 @@ public record GetAttendanceV1UserFlowsByUserFlowIdResponseDto public string Comment { get; set; } = string.Empty; /// - /// 打卡记录 ID + /// 对应打卡流水记录ID /// 必填:否 - /// 示例值:考勤内部的打卡记录ID, 6709359313699356941(导入时此参数无效) + /// 示例值:6709359313699356941 /// [JsonPropertyName("record_id")] public string? RecordId { get; set; } @@ -102,9 +111,9 @@ public record GetAttendanceV1UserFlowsByUserFlowIdResponseDto public bool? IsWifi { get; set; } /// - /// 记录生成方式 + /// 记录生成方式,在开放平台调用时,此参数无效,内部值始终是7 /// 必填:否 - /// 示例值:在开放平台调用时,此参数无效,内部值始终是7 + /// 示例值:7 /// 可选值: /// 0:用户打卡 /// 1:管理员修改 @@ -127,9 +136,9 @@ public record GetAttendanceV1UserFlowsByUserFlowIdResponseDto public string[]? PhotoUrls { get; set; } /// - /// 打卡设备ID + /// 打卡设备ID(只支持小程序打卡,导入时无效) /// 必填:否 - /// 示例值:(只支持小程序打卡,导入时无效)99e0609ee053448596502691a81428654d7ded64c7bd85acd982d26b3636c37d + /// 示例值:99e0609ee053448596502691a81428654d7ded64c7bd85acd982d26b3636c37d /// [JsonPropertyName("device_id")] public string? DeviceId { get; set; } @@ -161,4 +170,12 @@ public record GetAttendanceV1UserFlowsByUserFlowIdResponseDto /// [JsonPropertyName("external_id")] public string? ExternalId { get; set; } + + /// + /// 唯一幂等键 + /// 必填:否 + /// 示例值:****_*** + /// + [JsonPropertyName("idempotent_id")] + public string? IdempotentId { get; set; } } diff --git a/src/Attendance/GetAttendanceV1UserSettingsQueryBodyDto.cs b/src/Attendance/GetAttendanceV1UserSettingsQueryBodyDto.cs index 853f9d78..8a661a9c 100644 --- a/src/Attendance/GetAttendanceV1UserSettingsQueryBodyDto.cs +++ b/src/Attendance/GetAttendanceV1UserSettingsQueryBodyDto.cs @@ -14,7 +14,8 @@ namespace FeishuNetSdk.Attendance; /// /// 批量查询用户人脸识别信息 请求体 -/// 批量查询授权内员工的用户设置信息,包括人脸照片文件 ID、人脸照片更新时间。 +/// 批量查询授权内员工的用户设置信息,包括人脸照片文件 ID、人脸照片更新时间。对应页面假勤设置-[人脸识别](https://example.feishu.cn/people/workforce-management/setting/group/security)。根据返回的face_key可以下载人脸信息[下载用户人脸识别照片 +/// ](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/file/download) /// 接口ID:7044467124773584897 /// 文档地址:https://open.feishu.cn/document/server-docs/attendance-v1/user_setting/query /// JSON地址:https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fattendance-v1%2fuser_setting%2fquery @@ -22,7 +23,7 @@ namespace FeishuNetSdk.Attendance; public record GetAttendanceV1UserSettingsQueryBodyDto { /// - /// employee_no 或 employee_id 列表 + /// employee_no 或 employee_id 列表,对应employee_type /// 必填:是 /// 示例值:["abd754f7"] /// 最大长度:100 diff --git a/src/Attendance/GetAttendanceV1UserSettingsQueryResponseDto.cs b/src/Attendance/GetAttendanceV1UserSettingsQueryResponseDto.cs index c701aecc..928a3115 100644 --- a/src/Attendance/GetAttendanceV1UserSettingsQueryResponseDto.cs +++ b/src/Attendance/GetAttendanceV1UserSettingsQueryResponseDto.cs @@ -14,7 +14,8 @@ namespace FeishuNetSdk.Attendance; /// /// 批量查询用户人脸识别信息 响应体 -/// 批量查询授权内员工的用户设置信息,包括人脸照片文件 ID、人脸照片更新时间。 +/// 批量查询授权内员工的用户设置信息,包括人脸照片文件 ID、人脸照片更新时间。对应页面假勤设置-[人脸识别](https://example.feishu.cn/people/workforce-management/setting/group/security)。根据返回的face_key可以下载人脸信息[下载用户人脸识别照片 +/// ](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/file/download) /// 接口ID:7044467124773584897 /// 文档地址:https://open.feishu.cn/document/server-docs/attendance-v1/user_setting/query /// JSON地址:https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fattendance-v1%2fuser_setting%2fquery @@ -34,7 +35,7 @@ public record GetAttendanceV1UserSettingsQueryResponseDto public record UserSetting { /// - /// 用户 ID + /// 用户 ID,对应employee_type /// 必填:是 /// 示例值:abd754f7 /// @@ -42,7 +43,7 @@ public record UserSetting public string UserId { get; set; } = string.Empty; /// - /// 人脸照片文件 ID,获取方式:[文件上传](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/file/upload) + /// 人脸照片文件 ID,可用于:[下载用户人脸识别照片](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/file/download) /// 必填:是 /// 示例值:xxxxxb306842b1c189bc5212eefxxxxx /// diff --git a/src/Attendance/PostAttendanceV1UserApprovalsQueryBodyDto.cs b/src/Attendance/PostAttendanceV1UserApprovalsQueryBodyDto.cs index 3c708b6b..e74c0215 100644 --- a/src/Attendance/PostAttendanceV1UserApprovalsQueryBodyDto.cs +++ b/src/Attendance/PostAttendanceV1UserApprovalsQueryBodyDto.cs @@ -51,8 +51,8 @@ public record PostAttendanceV1UserApprovalsQueryBodyDto /// 示例值:PeriodTime /// 可选值: /// PeriodTime:单据作用时间 - /// CreateTime:单据创建时间(目前暂不支持) - /// UpdateTime:单据状态更新时间 + /// CreateTime:单据创建时间 + /// UpdateTime:单据状态更新时间(灰度中,暂不开放) /// /// [JsonPropertyName("check_date_type")] diff --git a/src/Attendance/PostAttendanceV1UserApprovalsQueryResponseDto.cs b/src/Attendance/PostAttendanceV1UserApprovalsQueryResponseDto.cs index dd5cd06c..28a29672 100644 --- a/src/Attendance/PostAttendanceV1UserApprovalsQueryResponseDto.cs +++ b/src/Attendance/PostAttendanceV1UserApprovalsQueryResponseDto.cs @@ -42,7 +42,7 @@ public record UserApproval public string UserId { get; set; } = string.Empty; /// - /// 审批作用日期 + /// 审批作用日期,格式yyyyMMdd /// 必填:是 /// 示例值:20210104 /// diff --git a/src/Attendance/PostAttendanceV1UserFlowsQueryBodyDto.cs b/src/Attendance/PostAttendanceV1UserFlowsQueryBodyDto.cs index e9c48335..b7d770f3 100644 --- a/src/Attendance/PostAttendanceV1UserFlowsQueryBodyDto.cs +++ b/src/Attendance/PostAttendanceV1UserFlowsQueryBodyDto.cs @@ -14,7 +14,16 @@ namespace FeishuNetSdk.Attendance; /// /// 批量查询打卡流水 请求体 -/// 批量查询授权内员工的实际打卡流水记录。例如,企业给一个员工设定的班次是上午 9 点和下午 6 点各打一次上下班卡,但是该员工在这期间打了多次卡,该接口会把所有的打卡记录都返回。 +/// 通过打卡记录 ID 获取用户的打卡流水记录。返回信息主要包含: +/// * 用户id和创建者id +/// * 记录信息 +/// * 打卡位置信息、时间信息 +/// * 打卡方式信息 +/// * GPS 打卡:location_name(定位地址信息) +/// * Wi-Fi 打卡:ssid(wifi名称)、bssid(mac地址) +/// * 考勤机打卡:device_id(考勤机设备id) +/// * 打卡结果 +/// 对应页面功能打卡管理-[打卡记录](https://example.feishu.cn/people/workforce-management/manage/statistics/flow) /// 接口ID:7044467124773617665 /// 文档地址:https://open.feishu.cn/document/server-docs/attendance-v1/user_task/query-2 /// JSON地址:https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fattendance-v1%2fuser_flow%2fquery @@ -24,13 +33,13 @@ public record PostAttendanceV1UserFlowsQueryBodyDto /// /// employee_no 或 employee_id 列表,长度不超过 50 /// 必填:是 - /// 示例值:["abd754f7"] + /// 示例值:[ "abd754f7"] /// [JsonPropertyName("user_ids")] public string[] UserIds { get; set; } = Array.Empty(); /// - /// 查询的起始时间,时间戳 + /// 查询的起始时间,秒级时间戳 /// 必填:是 /// 示例值:1566641088 /// @@ -38,7 +47,7 @@ public record PostAttendanceV1UserFlowsQueryBodyDto public string CheckTimeFrom { get; set; } = string.Empty; /// - /// 查询的结束时间,时间戳 + /// 查询的结束时间,秒级时间戳 /// 必填:是 /// 示例值:1566641088 /// diff --git a/src/Attendance/PostAttendanceV1UserFlowsQueryResponseDto.cs b/src/Attendance/PostAttendanceV1UserFlowsQueryResponseDto.cs index 924aaecd..ab5d4139 100644 --- a/src/Attendance/PostAttendanceV1UserFlowsQueryResponseDto.cs +++ b/src/Attendance/PostAttendanceV1UserFlowsQueryResponseDto.cs @@ -4,7 +4,7 @@ // Created : 2024-06-24 // // Last Modified By : yxr -// Last Modified On : 2024-06-24 +// Last Modified On : 2024-07-18 // ************************************************************************ // // MIT @@ -14,7 +14,16 @@ namespace FeishuNetSdk.Attendance; /// /// 批量查询打卡流水 响应体 -/// 批量查询授权内员工的实际打卡流水记录。例如,企业给一个员工设定的班次是上午 9 点和下午 6 点各打一次上下班卡,但是该员工在这期间打了多次卡,该接口会把所有的打卡记录都返回。 +/// 通过打卡记录 ID 获取用户的打卡流水记录。返回信息主要包含: +/// * 用户id和创建者id +/// * 记录信息 +/// * 打卡位置信息、时间信息 +/// * 打卡方式信息 +/// * GPS 打卡:location_name(定位地址信息) +/// * Wi-Fi 打卡:ssid(wifi名称)、bssid(mac地址) +/// * 考勤机打卡:device_id(考勤机设备id) +/// * 打卡结果 +/// 对应页面功能打卡管理-[打卡记录](https://example.feishu.cn/people/workforce-management/manage/statistics/flow) /// 接口ID:7044467124773617665 /// 文档地址:https://open.feishu.cn/document/server-docs/attendance-v1/user_task/query-2 /// JSON地址:https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fattendance-v1%2fuser_flow%2fquery @@ -34,7 +43,7 @@ public record PostAttendanceV1UserFlowsQueryResponseDto public record UserFlow { /// - /// 用户 ID + /// 用户 ID,对应employee_type /// 必填:是 /// 示例值:abd754f7 /// @@ -42,7 +51,7 @@ public record UserFlow public string UserId { get; set; } = string.Empty; /// - /// 记录创建者 ID + /// 记录创建者 ID,对应employee_type /// 必填:是 /// 示例值:abd754f7 /// @@ -58,7 +67,7 @@ public record UserFlow public string LocationName { get; set; } = string.Empty; /// - /// 打卡时间,精确到秒的时间戳 + /// 打卡时间,秒级时间戳 /// 必填:是 /// 示例值:1611476284 /// @@ -74,7 +83,7 @@ public record UserFlow public string Comment { get; set; } = string.Empty; /// - /// 打卡记录 ID + /// 对应打卡流水记录ID /// 必填:否 /// 示例值:6709359313699356941 /// @@ -114,7 +123,7 @@ public record UserFlow public bool? IsWifi { get; set; } /// - /// 记录生成方式 + /// 记录生成方式,在开放平台调用时,此参数无效,内部值始终是7 /// 必填:否 /// 示例值:7 /// 可选值: @@ -138,6 +147,14 @@ public record UserFlow [JsonPropertyName("photo_urls")] public string[]? PhotoUrls { get; set; } + /// + /// 打卡设备ID(只支持小程序打卡,导入时无效) + /// 必填:否 + /// 示例值:99e0609ee053448596502691a81428654d7ded64c7bd85acd982d26b3636c37d + /// + [JsonPropertyName("device_id")] + public string? DeviceId { get; set; } + /// /// 打卡结果,目前仅支持PendingApproval待生效 /// 必填:否 @@ -157,5 +174,21 @@ public record UserFlow /// [JsonPropertyName("check_result")] public string? CheckResult { get; set; } + + /// + /// 用户导入的外部打卡记录ID + /// 必填:否 + /// 示例值:record_123 + /// + [JsonPropertyName("external_id")] + public string? ExternalId { get; set; } + + /// + /// 唯一幂等键 + /// 必填:否 + /// 示例值:****_*** + /// + [JsonPropertyName("idempotent_id")] + public string? IdempotentId { get; set; } } } diff --git a/src/Attendance/PostAttendanceV1UserTaskRemedysQueryBodyDto.cs b/src/Attendance/PostAttendanceV1UserTaskRemedysQueryBodyDto.cs index 251f56ec..282db1f7 100644 --- a/src/Attendance/PostAttendanceV1UserTaskRemedysQueryBodyDto.cs +++ b/src/Attendance/PostAttendanceV1UserTaskRemedysQueryBodyDto.cs @@ -14,7 +14,7 @@ namespace FeishuNetSdk.Attendance; /// /// 获取补卡记录 请求体 -/// 获取授权内员工的补卡记录。 +/// 补卡:用户通过审批的方式,在某一次上/下班的打卡时间范围内,补充一条打卡记录,用以修正用户的考勤结果。本接口专用于获取员工的补卡记录(无页面功能对应) /// 接口ID:7044467124773666817 /// 文档地址:https://open.feishu.cn/document/server-docs/attendance-v1/user_task_remedy/query /// JSON地址:https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fattendance-v1%2fuser_task_remedy%2fquery @@ -52,7 +52,7 @@ public record PostAttendanceV1UserTaskRemedysQueryBodyDto /// 可选值: /// PeriodTime:单据作用时间 /// CreateTime:单据创建时间(目前暂不支持) - /// UpdateTime:单据状态更新时间(新增字段,对特定租户生效) + /// UpdateTime:单据状态更新时间(灰度中,暂不开放) /// /// [JsonPropertyName("check_date_type")] diff --git a/src/Attendance/PostAttendanceV1UserTaskRemedysQueryResponseDto.cs b/src/Attendance/PostAttendanceV1UserTaskRemedysQueryResponseDto.cs index 59fd8780..cbcdcdf3 100644 --- a/src/Attendance/PostAttendanceV1UserTaskRemedysQueryResponseDto.cs +++ b/src/Attendance/PostAttendanceV1UserTaskRemedysQueryResponseDto.cs @@ -14,7 +14,7 @@ namespace FeishuNetSdk.Attendance; /// /// 获取补卡记录 响应体 -/// 获取授权内员工的补卡记录。 +/// 补卡:用户通过审批的方式,在某一次上/下班的打卡时间范围内,补充一条打卡记录,用以修正用户的考勤结果。本接口专用于获取员工的补卡记录(无页面功能对应) /// 接口ID:7044467124773666817 /// 文档地址:https://open.feishu.cn/document/server-docs/attendance-v1/user_task_remedy/query /// JSON地址:https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fattendance-v1%2fuser_task_remedy%2fquery @@ -34,7 +34,7 @@ public record PostAttendanceV1UserTaskRemedysQueryResponseDto public record UserTaskRemedy { /// - /// 用户 ID + /// 用户 ID,对应employee_type /// 必填:是 /// 示例值:abd754f7 /// @@ -42,7 +42,7 @@ public record UserTaskRemedy public string UserId { get; set; } = string.Empty; /// - /// 补卡日期 + /// 补卡日期,格式为yyyyMMdd /// 必填:是 /// 示例值:20210701 /// @@ -58,7 +58,7 @@ public record UserTaskRemedy public int PunchNo { get; set; } /// - /// 上班 / 下班,1:上班,2:下班,自由班制填 0 + /// 上班 / 下班,1:上班,2:下班,自由班制为 1 /// 必填:是 /// 示例值:1 /// @@ -66,7 +66,7 @@ public record UserTaskRemedy public int WorkType { get; set; } /// - /// 审批 ID + /// 审批 ID,可用于[通知审批状态更新](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/approval_info/process) /// 必填:否 /// 示例值:6737202939523236113 /// @@ -76,7 +76,7 @@ public record UserTaskRemedy /// /// 补卡时间,时间格式为 yyyy-MM-dd HH:mm /// 必填:是 - /// 示例值:2021-07-0108:00 + /// 示例值:2021-07-01 08:00 /// [JsonPropertyName("remedy_time")] public string RemedyTime { get; set; } = string.Empty; diff --git a/src/Attendance/PostAttendanceV1UserTasksQueryBodyDto.cs b/src/Attendance/PostAttendanceV1UserTasksQueryBodyDto.cs index 80f07b87..a574f3c9 100644 --- a/src/Attendance/PostAttendanceV1UserTasksQueryBodyDto.cs +++ b/src/Attendance/PostAttendanceV1UserTasksQueryBodyDto.cs @@ -14,7 +14,23 @@ namespace FeishuNetSdk.Attendance; /// /// 查询打卡结果 请求体 -/// 获取企业内员工的实际打卡结果,包括上班打卡结果和下班打卡结果。 +/// 获取企业内员工的实际打卡结果,包括: +/// * 打卡任务列表 +/// * 打卡记录id +/// * 用户信息 +/// * 考勤组id +/// * 班次id +/// * 考勤记录 +/// * 上班记录 +/// * 下班记录 +/// * 上班打卡结果 +/// * 下班打卡结果 +/// * 上班打卡结果补充 +/// * 下班打卡结果补充 +/// * 上班打卡时间 +/// * 下班打卡时间 +/// * 无效用户id列表 +/// * 没有权限用户ID列表 /// 接口ID:7044467124773421057 /// 文档地址:https://open.feishu.cn/document/server-docs/attendance-v1/user_task/query /// JSON地址:https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fattendance-v1%2fuser_task%2fquery @@ -22,7 +38,7 @@ namespace FeishuNetSdk.Attendance; public record PostAttendanceV1UserTasksQueryBodyDto { /// - /// employee_no 或 employee_id 列表,长度不超过 50 + /// employee_no 或 employee_id 列表,对应employee_type,长度不超过 50 /// 必填:是 /// 示例值:abd754f7 /// @@ -30,7 +46,7 @@ public record PostAttendanceV1UserTasksQueryBodyDto public string[] UserIds { get; set; } = Array.Empty(); /// - /// 查询的起始工作日 + /// 查询的起始工作日,格式为yyyyMMdd /// 必填:是 /// 示例值:20190817 /// @@ -38,7 +54,7 @@ public record PostAttendanceV1UserTasksQueryBodyDto public int CheckDateFrom { get; set; } /// - /// 查询的结束工作日 + /// 查询的结束工作日,格式为yyyyMMdd /// 必填:是 /// 示例值:20190820 /// @@ -46,7 +62,7 @@ public record PostAttendanceV1UserTasksQueryBodyDto public int CheckDateTo { get; set; } /// - /// 是否需要加班班段打卡结果;加班班段通过task_shift_type=1标识,加班班段上下班与正常班段相连时 会出现共用flow_id情况。例如:9-18为正常班次,18-19为加班班次,打卡结果中records 会出现两段,分别为9-18,18-19 且两段上下班flow_id相同。非相连加班班次正常分段返回。 + /// 是否需要加班班段打卡结果;当need_overtime_result=true时,会返回加班班段,加班班段通过task_shift_type=1标识,加班班段上下班与正常班段相连时会出现共用record_id情况。例如:9-18为正常班次,18-19为加班班次,打卡结果中records 会出现两段,分别为9-18,18-19 且两段上下班record_id相同(check_in_record_id和check_out_record_id相同)。非相连加班班次正常分段返回。当need_overtime_result=false时,仅返回正常班段且task_shift_type=0。 /// 必填:否 /// 示例值:true /// diff --git a/src/Attendance/PostAttendanceV1UserTasksQueryResponseDto.cs b/src/Attendance/PostAttendanceV1UserTasksQueryResponseDto.cs index 807d1f5e..a943262f 100644 --- a/src/Attendance/PostAttendanceV1UserTasksQueryResponseDto.cs +++ b/src/Attendance/PostAttendanceV1UserTasksQueryResponseDto.cs @@ -4,7 +4,7 @@ // Created : 2024-06-24 // // Last Modified By : yxr -// Last Modified On : 2024-06-24 +// Last Modified On : 2024-07-18 // ************************************************************************ // // MIT @@ -14,7 +14,23 @@ namespace FeishuNetSdk.Attendance; /// /// 查询打卡结果 响应体 -/// 获取企业内员工的实际打卡结果,包括上班打卡结果和下班打卡结果。 +/// 获取企业内员工的实际打卡结果,包括: +/// * 打卡任务列表 +/// * 打卡记录id +/// * 用户信息 +/// * 考勤组id +/// * 班次id +/// * 考勤记录 +/// * 上班记录 +/// * 下班记录 +/// * 上班打卡结果 +/// * 下班打卡结果 +/// * 上班打卡结果补充 +/// * 下班打卡结果补充 +/// * 上班打卡时间 +/// * 下班打卡时间 +/// * 无效用户id列表 +/// * 没有权限用户ID列表 /// 接口ID:7044467124773421057 /// 文档地址:https://open.feishu.cn/document/server-docs/attendance-v1/user_task/query /// JSON地址:https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fattendance-v1%2fuser_task%2fquery @@ -42,7 +58,7 @@ public record UserTask public string ResultId { get; set; } = string.Empty; /// - /// 用户 ID + /// 用户 ID,对应employee_type /// 必填:是 /// 示例值:abd754f7 /// @@ -58,7 +74,7 @@ public record UserTask public string EmployeeName { get; set; } = string.Empty; /// - /// 日期 + /// 日期,格式为yyyyMMdd /// 必填:是 /// 示例值:20190819 /// @@ -66,7 +82,7 @@ public record UserTask public int Day { get; set; } /// - /// 考勤组 ID(特别说明:1代表未加入考勤组) + /// 考勤组 ID(特别说明:1代表未加入考勤组),可用于[按 ID 查询考勤组](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/group/get) /// 必填:是 /// 示例值:6737202939523236110 /// @@ -74,7 +90,7 @@ public record UserTask public string GroupId { get; set; } = string.Empty; /// - /// 班次 ID(特别说明:9代表默认班次) + /// 班次 ID(特别说明:9代表默认班次),可用于[按 ID 查询班次](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/shift/get) /// 必填:是 /// 示例值:6753520403404030215 /// @@ -114,7 +130,7 @@ public record TaskResult public record UserFlow { /// - /// 用户 ID + /// 用户 ID,对应employee_type /// 必填:是 /// 示例值:abd754f7 /// @@ -122,7 +138,7 @@ public record UserFlow public string UserId { get; set; } = string.Empty; /// - /// 记录创建者 ID + /// 记录创建者 ID,对应employee_type /// 必填:是 /// 示例值:abd754f7 /// @@ -154,7 +170,7 @@ public record UserFlow public string Comment { get; set; } = string.Empty; /// - /// 打卡记录 ID + /// 考勤内部的打卡记录ID(导入时此参数无效) /// 必填:否 /// 示例值:6709359313699356941 /// @@ -218,6 +234,14 @@ public record UserFlow [JsonPropertyName("photo_urls")] public string[]? PhotoUrls { get; set; } + /// + /// 打卡设备ID(只支持小程序打卡,导入时无效) + /// 必填:否 + /// 示例值:99e0609ee053448596502691a81428654d7ded64c7bd85acd982d26b3636c37d + /// + [JsonPropertyName("device_id")] + public string? DeviceId { get; set; } + /// /// 打卡结果 /// 必填:否 @@ -237,6 +261,22 @@ public record UserFlow /// [JsonPropertyName("check_result")] public string? CheckResult { get; set; } + + /// + /// 用户导入的外部打卡记录ID + /// 必填:否 + /// 示例值:record_123 + /// + [JsonPropertyName("external_id")] + public string? ExternalId { get; set; } + + /// + /// 唯一幂等键 + /// 必填:否 + /// 示例值:****_*** + /// + [JsonPropertyName("idempotent_id")] + public string? IdempotentId { get; set; } } /// @@ -325,7 +365,7 @@ public record UserFlow public string CheckOutResultSupplement { get; set; } = string.Empty; /// - /// 上班打卡时间 + /// 上班打卡时间,秒级时间戳 /// 必填:否 /// 示例值:1609722000 /// @@ -333,7 +373,7 @@ public record UserFlow public string? CheckInShiftTime { get; set; } /// - /// 下班打卡时间 + /// 下班打卡时间,秒级时间戳 /// 必填:否 /// 示例值:1609754400 /// @@ -351,14 +391,14 @@ public record UserFlow } /// - /// 无效用户 ID 列表 + /// 无效用户 ID 列表,对应employee_type /// 必填:否 /// [JsonPropertyName("invalid_user_ids")] public string[]? InvalidUserIds { get; set; } /// - /// 没有权限用户 ID 列表 + /// 没有权限用户 ID 列表,对应employee_type /// 必填:否 /// [JsonPropertyName("unauthorized_user_ids")] diff --git a/src/Auth/GetAuthenV1UserInfoResponseDto.cs b/src/Auth/GetAuthenV1UserInfoResponseDto.cs index 7699c78c..7f92949b 100644 --- a/src/Auth/GetAuthenV1UserInfoResponseDto.cs +++ b/src/Auth/GetAuthenV1UserInfoResponseDto.cs @@ -32,7 +32,7 @@ public record GetAuthenV1UserInfoResponseDto /// /// 用户英文名称 /// 必填:否 - /// 示例值:Three Zhang + /// 示例值:zhangsan /// [JsonPropertyName("en_name")] public string? EnName { get; set; } diff --git a/src/Calendar/GetCalendarV4CalendarsByCalendarIdEventsByEventIdAttendeesResponseDto.cs b/src/Calendar/GetCalendarV4CalendarsByCalendarIdEventsByEventIdAttendeesResponseDto.cs index e6876dd9..95e2266e 100644 --- a/src/Calendar/GetCalendarV4CalendarsByCalendarIdEventsByEventIdAttendeesResponseDto.cs +++ b/src/Calendar/GetCalendarV4CalendarsByCalendarIdEventsByEventIdAttendeesResponseDto.cs @@ -238,6 +238,7 @@ public record CalendarAttendeeResourceCustomization /// /// 每个配置的选项。 /// 必填:否 + /// 示例值:无 /// [JsonPropertyName("options")] public CustomizationOption[]? Options { get; set; } diff --git a/src/Calendar/GetCalendarV4CalendarsByCalendarIdEventsByEventIdResponseDto.cs b/src/Calendar/GetCalendarV4CalendarsByCalendarIdEventsByEventIdResponseDto.cs index bd1dee2d..c46c86e2 100644 --- a/src/Calendar/GetCalendarV4CalendarsByCalendarIdEventsByEventIdResponseDto.cs +++ b/src/Calendar/GetCalendarV4CalendarsByCalendarIdEventsByEventIdResponseDto.cs @@ -724,6 +724,7 @@ public record CalendarAttendeeResourceCustomization /// /// 每个配置的选项。 /// 必填:否 + /// 示例值:无 /// [JsonPropertyName("options")] public CustomizationOption[]? Options { get; set; } diff --git a/src/Calendar/GetCalendarV4CalendarsByCalendarIdEventsInstanceViewResponseDto.cs b/src/Calendar/GetCalendarV4CalendarsByCalendarIdEventsInstanceViewResponseDto.cs index c43da1b3..88354c08 100644 --- a/src/Calendar/GetCalendarV4CalendarsByCalendarIdEventsInstanceViewResponseDto.cs +++ b/src/Calendar/GetCalendarV4CalendarsByCalendarIdEventsInstanceViewResponseDto.cs @@ -555,6 +555,7 @@ public record CalendarAttendeeResourceCustomization /// /// 每个配置的选项。 /// 必填:否 + /// 示例值:无 /// [JsonPropertyName("options")] public CustomizationOption[]? Options { get; set; } diff --git a/src/Calendar/PostCalendarV4CalendarsByCalendarIdEventsByEventIdAttendeesBodyDto.cs b/src/Calendar/PostCalendarV4CalendarsByCalendarIdEventsByEventIdAttendeesBodyDto.cs index b02abfd0..8e8b0658 100644 --- a/src/Calendar/PostCalendarV4CalendarsByCalendarIdEventsByEventIdAttendeesBodyDto.cs +++ b/src/Calendar/PostCalendarV4CalendarsByCalendarIdEventsByEventIdAttendeesBodyDto.cs @@ -146,6 +146,7 @@ public record CalendarAttendeeResourceCustomization /// /// 每个配置的选项。 /// 必填:否 + /// 示例值:无 /// [JsonPropertyName("options")] public CustomizationOption[]? Options { get; set; } diff --git a/src/Calendar/PostCalendarV4CalendarsByCalendarIdEventsByEventIdAttendeesResponseDto.cs b/src/Calendar/PostCalendarV4CalendarsByCalendarIdEventsByEventIdAttendeesResponseDto.cs index f0332b95..4e2982ff 100644 --- a/src/Calendar/PostCalendarV4CalendarsByCalendarIdEventsByEventIdAttendeesResponseDto.cs +++ b/src/Calendar/PostCalendarV4CalendarsByCalendarIdEventsByEventIdAttendeesResponseDto.cs @@ -236,6 +236,7 @@ public record CalendarAttendeeResourceCustomization /// /// 每个配置的选项。 /// 必填:否 + /// 示例值:无 /// [JsonPropertyName("options")] public CustomizationOption[]? Options { get; set; } diff --git a/src/Calendar/PostCalendarV4CalendarsByCalendarIdEventsByEventIdMeetingMinuteResponseDto.cs b/src/Calendar/PostCalendarV4CalendarsByCalendarIdEventsByEventIdMeetingMinuteResponseDto.cs new file mode 100644 index 00000000..8ecfa7fd --- /dev/null +++ b/src/Calendar/PostCalendarV4CalendarsByCalendarIdEventsByEventIdMeetingMinuteResponseDto.cs @@ -0,0 +1,31 @@ +// ************************************************************************ +// Assembly : FeishuNetSdk +// Author : yxr +// Created : 2024-07-18 +// +// Last Modified By : yxr +// Last Modified On : 2024-07-18 +// ************************************************************************ +// +// MIT +// +// 创建会议纪要 响应体 +// ************************************************************************ +namespace FeishuNetSdk.Calendar; +/// +/// 创建会议纪要 响应体 +/// 调用该接口为指定的日程创建会议纪要。纪要以文档形式展示,成功创建后会返回纪要文档 URL。 +/// 接口ID:7263360328350760964 +/// 文档地址:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event-meeting_minute/create +/// JSON地址:https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fcalendar-v4%2fcalendar-event-meeting_minute%2fcreate +/// +public record PostCalendarV4CalendarsByCalendarIdEventsByEventIdMeetingMinuteResponseDto +{ + /// + /// 文档 URL + /// 必填:否 + /// 示例值:https://example.cn/xxx + /// + [JsonPropertyName("doc_url")] + public string? DocUrl { get; set; } +} diff --git a/src/Ccm.Spec/DeleteSheetsV2SpreadsheetsBySpreadsheetTokenDataValidationBodyDto.cs b/src/Ccm.Spec/DeleteSheetsV2SpreadsheetsBySpreadsheetTokenDataValidationBodyDto.cs index 238084cc..413a2d07 100644 --- a/src/Ccm.Spec/DeleteSheetsV2SpreadsheetsBySpreadsheetTokenDataValidationBodyDto.cs +++ b/src/Ccm.Spec/DeleteSheetsV2SpreadsheetsBySpreadsheetTokenDataValidationBodyDto.cs @@ -4,7 +4,7 @@ // Created : 2024-06-24 // // Last Modified By : yxr -// Last Modified On : 2024-06-24 +// Last Modified On : 2024-07-18 // ************************************************************************ // // MIT @@ -14,7 +14,8 @@ namespace FeishuNetSdk.Ccm.Spec; /// /// 删除下拉列表设置 请求体 -/// 该接口根据 spreadsheetToken 、range 移除选定数据范围单元格的下拉列表设置,但保留选项文本。单个删除范围不超过5000单元格。单次请求range最大数量100个。 +/// 删除电子表格工作表指定范围中下拉列表的设置,但仍保留选项文本。 +/// 使用限制:单次删除请求可指定多个范围,单个范围指定的单元格不可超过 5,000 个,范围的总数不可超过 100 个。 /// 接口ID:6943917246700257282 /// 文档地址:https://open.feishu.cn/document/server-docs/docs/sheets-v3/datavalidation/delete-datavalidation /// JSON地址:https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fukTMukTMukTM%2fuATMzUjLwEzM14CMxMTN%2fdatavalidation%2fdelete-datavalidation @@ -22,24 +23,29 @@ namespace FeishuNetSdk.Ccm.Spec; public record DeleteSheetsV2SpreadsheetsBySpreadsheetTokenDataValidationBodyDto { /// - /// 范围数组,每个range 最大单元格数量5000,每个range独立执行,一个range的失败不影响其他range的执行。返回结果会返回每个range的执行结果 - /// 必填:否 + /// 指定要删除的下拉列表的范围和 ID。可指定多个范围。 + /// **注意**: + /// - 删除某个范围失败不影响其它范围的执行。响应体中将返回每个范围的执行结果。 + /// - 单个范围指定的单元格不可超过 5,000 个,范围的总数不可超过 100 个。 + /// 必填:是 /// [JsonPropertyName("dataValidationRanges")] - public DataValidationRange[]? DataValidationRanges { get; set; } + public DataValidationRange[] DataValidationRanges { get; set; } = Array.Empty(); /// public record DataValidationRange { /// - /// 查询范围,包含 sheetId 与单元格范围两部分,目前支持四种索引方式,详见[在线表格开发指南](https://open.feishu.cn/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/overview) + /// 要删除的下拉列表的范围。格式为 `<sheetId>!<开始位置>:<结束位置>`。其中: + /// - `sheetId` 为工作表 ID,通过[获取工作表](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet/query) 获取 + /// - `<开始位置>:<结束位置>` 为工作表中单元格的范围,数字表示行索引,字母表示列索引。如 `A2:B2` 表示该工作表第 2 行的 A 列到 B 列。`range`支持四种写法,详情参考[电子表格概述](https://open.feishu.cn/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/overview) /// 必填:是 /// [JsonPropertyName("range")] public string Range { get; set; } = string.Empty; /// - /// 指定需要删除的dataValidationIds + /// 要删除的下拉列表的 ID。可通过调用[查询下拉列表设置](https://open.feishu.cn/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/datavalidation/query-datavalidation)获取 /// 必填:是 /// [JsonPropertyName("dataValidationIds")] diff --git a/src/Ccm.Spec/DeleteSheetsV2SpreadsheetsBySpreadsheetTokenDataValidationResponseDto.cs b/src/Ccm.Spec/DeleteSheetsV2SpreadsheetsBySpreadsheetTokenDataValidationResponseDto.cs index fff5fa00..c8fb970d 100644 --- a/src/Ccm.Spec/DeleteSheetsV2SpreadsheetsBySpreadsheetTokenDataValidationResponseDto.cs +++ b/src/Ccm.Spec/DeleteSheetsV2SpreadsheetsBySpreadsheetTokenDataValidationResponseDto.cs @@ -14,7 +14,8 @@ namespace FeishuNetSdk.Ccm.Spec; /// /// 删除下拉列表设置 响应体 -/// 该接口根据 spreadsheetToken 、range 移除选定数据范围单元格的下拉列表设置,但保留选项文本。单个删除范围不超过5000单元格。单次请求range最大数量100个。 +/// 删除电子表格工作表指定范围中下拉列表的设置,但仍保留选项文本。 +/// 使用限制:单次删除请求可指定多个范围,单个范围指定的单元格不可超过 5,000 个,范围的总数不可超过 100 个。 /// 接口ID:6943917246700257282 /// 文档地址:https://open.feishu.cn/document/server-docs/docs/sheets-v3/datavalidation/delete-datavalidation /// JSON地址:https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fukTMukTMukTM%2fuATMzUjLwEzM14CMxMTN%2fdatavalidation%2fdelete-datavalidation @@ -22,7 +23,7 @@ namespace FeishuNetSdk.Ccm.Spec; public record DeleteSheetsV2SpreadsheetsBySpreadsheetTokenDataValidationResponseDto { /// - /// array + /// 删除下拉列表设置的结果 /// 必填:否 /// [JsonPropertyName("rangeResults")] @@ -32,11 +33,11 @@ public record DeleteSheetsV2SpreadsheetsBySpreadsheetTokenDataValidationResponse public record RangeResult { /// - /// 执行的range,与请求入参中的range 对应 - /// 必填:是 + /// 要删除的范围,与请求参数中 range 的值对应。 + /// 必填:否 /// [JsonPropertyName("range")] - public string Range { get; set; } = string.Empty; + public string? Range { get; set; } /// /// 结果信息 @@ -46,17 +47,17 @@ public record RangeResult public string? Msg { get; set; } /// - /// 执行结果 - /// 必填:是 + /// 是否成功删除该范围中的下拉列表设置。 + /// 必填:否 /// [JsonPropertyName("success")] - public bool Success { get; set; } + public bool? Success { get; set; } /// - /// 影响的单元格数量 - /// 必填:是 + /// 影响的单元格总数 + /// 必填:否 /// [JsonPropertyName("updatedCells")] - public int UpdatedCells { get; set; } + public int? UpdatedCells { get; set; } } } diff --git a/src/Ccm.Spec/GetSheetsV2SpreadsheetsBySpreadsheetTokenDataValidationResponseDto.cs b/src/Ccm.Spec/GetSheetsV2SpreadsheetsBySpreadsheetTokenDataValidationResponseDto.cs index 5cf54e92..cd7e4874 100644 --- a/src/Ccm.Spec/GetSheetsV2SpreadsheetsBySpreadsheetTokenDataValidationResponseDto.cs +++ b/src/Ccm.Spec/GetSheetsV2SpreadsheetsBySpreadsheetTokenDataValidationResponseDto.cs @@ -14,7 +14,9 @@ namespace FeishuNetSdk.Ccm.Spec; /// /// 查询下拉列表设置 响应体 -/// 该接口根据 spreadsheetToken 、range 查询range内的下拉列表设置信息;单次查询范围不超过5000行,100列。 +/// 查询电子表格工作表中指定范围的下拉列表的设置信息。 +/// 使用限制: +/// 单次查询范围不得超过 5000 行、100列。 /// 接口ID:6943917246700306434 /// 文档地址:https://open.feishu.cn/document/server-docs/docs/sheets-v3/datavalidation/query-datavalidation /// JSON地址:https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fukTMukTMukTM%2fuATMzUjLwEzM14CMxMTN%2fdatavalidation%2fquery-datavalidation @@ -22,25 +24,25 @@ namespace FeishuNetSdk.Ccm.Spec; public record GetSheetsV2SpreadsheetsBySpreadsheetTokenDataValidationResponseDto { /// - /// spreadsheet的token - /// 必填:是 + /// 电子表格的 token + /// 必填:否 /// [JsonPropertyName("spreadsheetToken")] - public string SpreadsheetToken { get; set; } = string.Empty; + public string? SpreadsheetToken { get; set; } /// - /// 工作表 sheet 的 id - /// 必填:是 + /// 工作表的 ID + /// 必填:否 /// [JsonPropertyName("sheetId")] - public string SheetId { get; set; } = string.Empty; + public string? SheetId { get; set; } /// - /// 版本号 - /// 必填:是 + /// 工作表的版本号。从 0 开始计数,更新一次版本号加一。 + /// 必填:否 /// [JsonPropertyName("revision")] - public int Revision { get; set; } + public int? Revision { get; set; } /// /// 下拉列表数组, 不存在时为空 @@ -53,52 +55,56 @@ public record GetSheetsV2SpreadsheetsBySpreadsheetTokenDataValidationResponseDto public record DataValidation { /// - /// 唯一标示id - /// 必填:是 + /// 下拉列表的 ID + /// 必填:否 /// [JsonPropertyName("dataValidationId")] - public int DataValidationId { get; set; } + public int? DataValidationId { get; set; } /// - /// 固定为"list",表示下拉列表 - /// 必填:是 + /// 数据验证的类型。下拉列表为 "list"。 + /// 必填:否 /// [JsonPropertyName("dataValidationType")] - public string DataValidationType { get; set; } = string.Empty; + public string? DataValidationType { get; set; } /// - /// 下拉列表选项值 - /// 必填:是 + /// 下拉列表选项的值 + /// 必填:否 /// [JsonPropertyName("conditionValues")] - public string[] ConditionValues { get; set; } = Array.Empty(); + public string[]? ConditionValues { get; set; } /// - /// 可选属性 + /// 下拉选项其它配置,包括是否支持多选、是否设置下拉选项样式等。 /// 必填:否 /// [JsonPropertyName("options")] - public Option? Options { get; set; } + public string? Options { get; set; } /// public record Option { /// - /// 单选填false, 多选填true + /// 是否支持多选选项。可选值: + /// - false:不支持多选 + /// - true:支持多选 /// 必填:否 /// [JsonPropertyName("multipleValues")] public bool? MultipleValues { get; set; } /// - /// 是否设置颜色和胶囊样式 + /// 是否为下拉选项设置颜色。可选值: + /// - false:不设置颜色 + /// - true:为下拉选项设置颜色 /// 必填:否 /// [JsonPropertyName("highlightValidData")] public bool? HighlightValidData { get; set; } /// - /// 当highlightValidData为true时,colorValueMap的key与conditionValues中的值一一对应,value为对应的颜色参数。 + /// 指定的下拉选项的颜色。格式为 RGB 十六进制,如 "#fffd00"。颜色将与 conditionValues 中的值按顺序一一对应。 /// 必填:否 /// [JsonPropertyName("colorValueMap")] diff --git a/src/Ccm.Spec/GetSheetsV2SpreadsheetsBySpreadsheetTokenProtectedRangeBatchGetResponseDto.cs b/src/Ccm.Spec/GetSheetsV2SpreadsheetsBySpreadsheetTokenProtectedRangeBatchGetResponseDto.cs index b9dd85f4..32bed11e 100644 --- a/src/Ccm.Spec/GetSheetsV2SpreadsheetsBySpreadsheetTokenProtectedRangeBatchGetResponseDto.cs +++ b/src/Ccm.Spec/GetSheetsV2SpreadsheetsBySpreadsheetTokenProtectedRangeBatchGetResponseDto.cs @@ -14,9 +14,10 @@ namespace FeishuNetSdk.Ccm.Spec; /// /// 获取保护范围 响应体 -/// 该接口用于根据保护范围ID查询详细的保护行列信息,最多支持同时查询5个ID。 -/// 1. 仅支持获取保护行或保护列,暂不支持获取保护单元格 -/// 2. 不支持获取包含多个区域的保护范围 +/// 获取电子表格工作表中指定保护范围的信息,包括保护的行列索引、支持编辑的用户 ID、保护范围的备注等。 +/// 使用限制: +/// - 单次调用该接口,最多支持获取 5 个保护范围的信息。 +/// - 不支持获取包含多个区域的保护范围。即如果一个保护范围中添加了多个区域,例如 B22:B26 和 C26:C28,则不支持调用该接口获取。 /// 接口ID:6923123667871596572 /// 文档地址:https://open.feishu.cn/document/server-docs/docs/sheets-v3/protect-range/retrieve-protection-scopes /// JSON地址:https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fukTMukTMukTM%2fuQTM5YjL0ETO24CNxkjN @@ -24,7 +25,7 @@ namespace FeishuNetSdk.Ccm.Spec; public record GetSheetsV2SpreadsheetsBySpreadsheetTokenProtectedRangeBatchGetResponseDto { /// - /// 保护范围 + /// 保护范围的信息 /// 必填:否 /// [JsonPropertyName("protectedRanges")] @@ -34,14 +35,14 @@ public record GetSheetsV2SpreadsheetsBySpreadsheetTokenProtectedRangeBatchGetRes public record ProtectedRange { /// - /// 保护范围ID + /// 保护范围的 ID /// 必填:否 /// [JsonPropertyName("protectId")] public string? ProtectId { get; set; } /// - /// 保护范围,如果为空,则为保护子表 + /// 保护范围的维度信息。为空表示保护整个工作表。 /// 必填:否 /// [JsonPropertyName("dimension")] @@ -51,50 +52,51 @@ public record ProtectedRange public record DimensionSuffix { /// - /// sheet 的 id + /// 工作表的 ID /// 必填:否 /// [JsonPropertyName("sheetId")] public string? SheetId { get; set; } /// - /// 保护行列起始下标,下标从1开始 + /// 开始的行或列的索引。从 1 开始计数。若 `startIndex` 为 3,则从第 3 行或列开始保护。包含第 3 行或列。 /// 必填:否 /// [JsonPropertyName("startIndex")] public int? StartIndex { get; set; } /// - /// 保护行列终止下标,下标从1开始 + /// 结束的行或列的索引。从 1 开始计数。若 `endIndex` 为 7,则保护到第 7 行或列。包含第 7 行或列。 /// 必填:否 /// [JsonPropertyName("endIndex")] public int? EndIndex { get; set; } /// - /// 保护范围的维度,COLUMNS为保护列,ROWS为保护行 + /// 保护范围的维度。可选值: + /// - ROWS:行 + /// - COLUMNS:列 /// 必填:否 /// [JsonPropertyName("majorDimension")] public string? MajorDimension { get; set; } } - /// - /// sheet的id + /// 工作表的 ID /// 必填:否 /// [JsonPropertyName("sheetId")] public string? SheetId { get; set; } /// - /// 保护说明 + /// 保护范围的备注信息 /// 必填:否 /// [JsonPropertyName("lockInfo")] public string? LockInfo { get; set; } /// - /// 用户信息 + /// 允许编辑保护范围的用户信息 /// 必填:否 /// [JsonPropertyName("editors")] @@ -104,7 +106,7 @@ public record DimensionSuffix public record Editor { /// - /// 用户信息列表 + /// 用户信息的列表 /// 必填:否 /// [JsonPropertyName("users")] @@ -114,14 +116,14 @@ public record Editor public record User { /// - /// 用户类型 + /// 用户 ID 的类型 /// 必填:否 /// [JsonPropertyName("memberType")] public string? MemberType { get; set; } /// - /// 用户ID + /// 用户的 ID /// 必填:否 /// [JsonPropertyName("memberId")] @@ -129,5 +131,4 @@ public record User } } } - } diff --git a/src/Ccm.Spec/PostSheetsV2SpreadsheetsBySpreadsheetTokenDataValidationBodyDto.cs b/src/Ccm.Spec/PostSheetsV2SpreadsheetsBySpreadsheetTokenDataValidationBodyDto.cs index 65c7685f..44cad379 100644 --- a/src/Ccm.Spec/PostSheetsV2SpreadsheetsBySpreadsheetTokenDataValidationBodyDto.cs +++ b/src/Ccm.Spec/PostSheetsV2SpreadsheetsBySpreadsheetTokenDataValidationBodyDto.cs @@ -14,7 +14,9 @@ namespace FeishuNetSdk.Ccm.Spec; /// /// 设置下拉列表 请求体 -/// 该接口根据 spreadsheetToken 、range 和下拉列表属性给单元格设置下拉列表规则;单次设置范围不超过5000行,100列。当一个数据区域中已有数据,支持将有效数据直接转为选项。 +/// 在电子表格工作表中为指定区域添加下拉列表选项,并设置下拉列表的属性,包括是否支持多选、设置下拉选项样式等。若一个数据区域中已有数据,支持将有效数据直接转为下拉列表中的选项。 +/// 使用限制: +/// 单次调用该接口,最多支持为 5,000 行、100 列设置下拉列表。 /// 接口ID:6943917246700290050 /// 文档地址:https://open.feishu.cn/document/server-docs/docs/sheets-v3/datavalidation/set-dropdown /// JSON地址:https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fukTMukTMukTM%2fuATMzUjLwEzM14CMxMTN%2fdatavalidation%2fset-dropdown @@ -22,14 +24,17 @@ namespace FeishuNetSdk.Ccm.Spec; public record PostSheetsV2SpreadsheetsBySpreadsheetTokenDataValidationBodyDto { /// - /// 查询范围,包含 sheetId 与单元格范围两部分,目前支持四种索引方式,详见 [在线表格开发指南](https://open.feishu.cn/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/overview) + /// 设置下拉选项的范围。格式为 `<sheetId>!<开始位置>:<结束位置>`。其中: + /// - `sheetId` 为工作表 ID,通过[获取工作表](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet/query) 获取。 + /// - `<开始位置>:<结束位置>` 为工作表中单元格的范围,数字表示行索引,字母表示列索引。如 `A2:B2` 表示该工作表第 2 行的 A 列到 B 列。`range`支持四种写法,详情参考[电子表格概述](https://open.feishu.cn/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/overview)。 + /// **示例值**:"8fe9d6!C1:H14" /// 必填:是 /// [JsonPropertyName("range")] public string Range { get; set; } = string.Empty; /// - /// 下拉列表填"list" + /// 数据验证的类型。支持下拉列表,请填写 "list"。 /// 必填:是 /// [JsonPropertyName("dataValidationType")] @@ -37,23 +42,28 @@ public record PostSheetsV2SpreadsheetsBySpreadsheetTokenDataValidationBodyDto /// /// 下拉列表规则属性 - /// 必填:否 + /// 必填:是 /// [JsonPropertyName("dataValidation")] - public DataValidationSuffix? DataValidation { get; set; } + public DataValidationSuffix DataValidation { get; set; } = new(); /// public record DataValidationSuffix { /// - /// 下拉列表选项值, 需为字符串,不能包含",",选项值最长100字符,选项个数最多500个 + /// 下拉列表选项的值。 + /// **数据校验规则**: + /// - 单个值需为字符串类型且不能包含 "," + /// - 单个值的长度不可超过 100 字节 + /// - 选项值的个数不可超过 500 个 + /// **示例值**:["2", "89", "3","2"] /// 必填:是 /// [JsonPropertyName("conditionValues")] public string[] ConditionValues { get; set; } = Array.Empty(); /// - /// 可选属性 + /// 下拉选项其它配置,包括是否支持多选、是否设置下拉选项样式等。 /// 必填:否 /// [JsonPropertyName("options")] @@ -63,21 +73,28 @@ public record DataValidationSuffix public record Option { /// - /// 单选填false, 多选填true,不填默认为false + /// 是否支持多选选项。可选值: + /// - false:不支持多选 + /// - true:支持多选 + /// **默认值**:false,即不支持多选选项 /// 必填:否 /// [JsonPropertyName("multipleValues")] public bool? MultipleValues { get; set; } /// - /// 是否设置颜色和胶囊样式, 不填默认为false + /// 是否为下拉选项设置颜色。可选值: + /// - false:不设置颜色 + /// - true:为下拉选项设置颜色。需进一步配置 colors 参数 + /// **默认值**:false,即不设置颜色 /// 必填:否 /// [JsonPropertyName("highlightValidData")] public bool? HighlightValidData { get; set; } /// - /// 当highlightValidData为true时,color需填颜色,与conditionValues中的值一一对应。需是RGB16进制格式,如"#fffd00" + /// 指定下拉选项的颜色。格式为 RGB 16 进制,如 "#fffd00"。当 `highlightValidData` 为 true 时,该参数必填。颜色将与 conditionValues 中的值按顺序一一对应。 + /// **示例值**:["#1FB6C1", "#F006C2", "#FB16C3","#FFB6C1"] /// 必填:否 /// [JsonPropertyName("colors")] diff --git a/src/Ccm.Spec/PostSheetsV2SpreadsheetsBySpreadsheetTokenDataValidationResponseDto.cs b/src/Ccm.Spec/PostSheetsV2SpreadsheetsBySpreadsheetTokenDataValidationResponseDto.cs new file mode 100644 index 00000000..816fbb3d --- /dev/null +++ b/src/Ccm.Spec/PostSheetsV2SpreadsheetsBySpreadsheetTokenDataValidationResponseDto.cs @@ -0,0 +1,32 @@ +// ************************************************************************ +// Assembly : FeishuNetSdk +// Author : yxr +// Created : 2024-07-18 +// +// Last Modified By : yxr +// Last Modified On : 2024-07-18 +// ************************************************************************ +// +// MIT +// +// 设置下拉列表 响应体 +// ************************************************************************ +namespace FeishuNetSdk.Ccm.Spec; +/// +/// 设置下拉列表 响应体 +/// 在电子表格工作表中为指定区域添加下拉列表选项,并设置下拉列表的属性,包括是否支持多选、设置下拉选项样式等。若一个数据区域中已有数据,支持将有效数据直接转为下拉列表中的选项。 +/// 使用限制: +/// 单次调用该接口,最多支持为 5,000 行、100 列设置下拉列表。 +/// 接口ID:6943917246700290050 +/// 文档地址:https://open.feishu.cn/document/server-docs/docs/sheets-v3/datavalidation/set-dropdown +/// JSON地址:https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fukTMukTMukTM%2fuATMzUjLwEzM14CMxMTN%2fdatavalidation%2fset-dropdown +/// +public record PostSheetsV2SpreadsheetsBySpreadsheetTokenDataValidationResponseDto +{ + /// + /// 状态码,0 代表成功 + /// 必填:是 + /// + [JsonPropertyName("code")] + public int Code { get; set; } +} diff --git a/src/Ccm.Spec/PostSheetsV2SpreadsheetsBySpreadsheetTokenProtectedDimensionBodyDto.cs b/src/Ccm.Spec/PostSheetsV2SpreadsheetsBySpreadsheetTokenProtectedDimensionBodyDto.cs new file mode 100644 index 00000000..af2b0e59 --- /dev/null +++ b/src/Ccm.Spec/PostSheetsV2SpreadsheetsBySpreadsheetTokenProtectedDimensionBodyDto.cs @@ -0,0 +1,98 @@ +// ************************************************************************ +// Assembly : FeishuNetSdk +// Author : yxr +// Created : 2024-07-18 +// +// Last Modified By : yxr +// Last Modified On : 2024-07-18 +// ************************************************************************ +// +// MIT +// +// 增加保护范围 请求体 +// ************************************************************************ +namespace FeishuNetSdk.Ccm.Spec; +/// +/// 增加保护范围 请求体 +/// 在电子表格工作表中设置多个保护范围,支持对行或列设置保护范围。 +/// 接口ID:6907569742383988738 +/// 文档地址:https://open.feishu.cn/document/server-docs/docs/sheets-v3/protect-range/add-locked-cells +/// JSON地址:https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fukTMukTMukTM%2fugDNzUjL4QzM14CO0MTN +/// +public record PostSheetsV2SpreadsheetsBySpreadsheetTokenProtectedDimensionBodyDto +{ + /// + /// 需要增加保护范围的维度信息。支持传入多个维度信息。 + /// 必填:是 + /// + [JsonPropertyName("addProtectedDimension")] + public ProtectedDimension[] AddProtectedDimension { get; set; } = Array.Empty(); + + /// + public record ProtectedDimension + { + /// + /// 要保护的行或列的信息 + /// 必填:是 + /// + [JsonPropertyName("dimension")] + public DimensionSuffix Dimension { get; set; } = new(); + + /// + public record DimensionSuffix + { + /// + /// 电子表格工作表的 ID。调用[获取工作表](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet/query)获取 ID。 + /// 必填:是 + /// + [JsonPropertyName("sheetId")] + public string SheetId { get; set; } = string.Empty; + + /// + /// 更新的维度,默认 ROWS。可选值: + /// - ROWS:行 + /// - COLUMNS:列 + /// 必填:否 + /// + [JsonPropertyName("majorDimension")] + public string? MajorDimension { get; set; } + + /// + /// 开始的行或列的索引。从 1 开始计数。若 `startIndex` 为 3,则从第 3 行或列开始保护。包含第 3 行或列。 + /// 必填:是 + /// + [JsonPropertyName("startIndex")] + public int StartIndex { get; set; } + + /// + /// 结束的行或列的索引。从 1 开始计数。若 `endIndex` 为 7,则保护到第 7 行或列。包含第 7 行或列。 + /// 必填:是 + /// + [JsonPropertyName("endIndex")] + public int EndIndex { get; set; } + } + + /// + /// 允许编辑保护范围的用户的 `lark_id`。该字段已不推荐使用,你可使用 `users` 参数代替。 + /// 必填:否 + /// + [Obsolete("使用 `users` 参数代替")] + [JsonPropertyName("editors")] + public long[]? Editors { get; set; } + + /// + /// 允许编辑保护范围的用户的 ID。ID 类型取决于查询参数 `user_id_type` 的取值。 + /// 必填:否 + /// + [JsonPropertyName("users")] + public string[]? Users { get; set; } + + /// + /// 保护范围的备注信息 + /// 必填:否 + /// + [JsonPropertyName("lockInfo")] + public string? LockInfo { get; set; } + + } +} diff --git a/src/Ccm.Spec/PostSheetsV2SpreadsheetsBySpreadsheetTokenProtectedDimensionResponseDto.cs b/src/Ccm.Spec/PostSheetsV2SpreadsheetsBySpreadsheetTokenProtectedDimensionResponseDto.cs new file mode 100644 index 00000000..88d3fc8a --- /dev/null +++ b/src/Ccm.Spec/PostSheetsV2SpreadsheetsBySpreadsheetTokenProtectedDimensionResponseDto.cs @@ -0,0 +1,102 @@ +// ************************************************************************ +// Assembly : FeishuNetSdk +// Author : yxr +// Created : 2024-07-18 +// +// Last Modified By : yxr +// Last Modified On : 2024-07-18 +// ************************************************************************ +// +// MIT +// +// 增加保护范围 响应体 +// ************************************************************************ +namespace FeishuNetSdk.Ccm.Spec; +/// +/// 增加保护范围 响应体 +/// 在电子表格工作表中设置多个保护范围,支持对行或列设置保护范围。 +/// 接口ID:6907569742383988738 +/// 文档地址:https://open.feishu.cn/document/server-docs/docs/sheets-v3/protect-range/add-locked-cells +/// JSON地址:https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fukTMukTMukTM%2fugDNzUjL4QzM14CO0MTN +/// +public record PostSheetsV2SpreadsheetsBySpreadsheetTokenProtectedDimensionResponseDto +{ + /// + /// 保护范围的维度信息 + /// 必填:是 + /// + [JsonPropertyName("addProtectedDimension")] + public ProtectedDimension[] AddProtectedDimension { get; set; } = Array.Empty(); + + /// + public record ProtectedDimension + { + /// + /// 保护范围的信息 + /// 必填:否 + /// + [JsonPropertyName("dimension")] + public DimensionSuffix? Dimension { get; set; } + + /// + public record DimensionSuffix + { + /// + /// 保护范围所在的工作表的 ID + /// 必填:否 + /// + [JsonPropertyName("sheetId")] + public string? SheetId { get; set; } + + /// + /// 保护范围的维度。枚举值: + /// - ROWS:行 + /// - COLUMNS:列 + /// 必填:否 + /// + [JsonPropertyName("majorDimension")] + public string? MajorDimension { get; set; } + + /// + /// 保护范围开始的行或列的索引。 + /// 必填:否 + /// + [JsonPropertyName("startIndex")] + public int? StartIndex { get; set; } + + /// + /// 保护范围结束的行或列的索引。 + /// 必填:否 + /// + [JsonPropertyName("endIndex")] + public int? EndIndex { get; set; } + } + /// + /// 允许编辑保护范围的用户的 `lark_id`。 + /// 必填:否 + /// + [JsonPropertyName("editors")] + public long[]? Editors { get; set; } + + /// + /// 允许编辑保护范围的用户的 ID。ID 类型取决于查询参数 `user_id_type`。 + /// 必填:否 + /// + [JsonPropertyName("users")] + public string[]? Users { get; set; } + + /// + /// 保护范围的备注信息 + /// 必填:否 + /// + [JsonPropertyName("lockInfo")] + public string? LockInfo { get; set; } + + /// + /// 保护范围的 ID + /// 必填:否 + /// + [JsonPropertyName("protectId")] + public string? ProtectId { get; set; } + } +} diff --git a/src/Ccm.Spec/PostSheetsV2SpreadsheetsBySpreadsheetTokenProtectedRangeBatchUpdateBodyDto.cs b/src/Ccm.Spec/PostSheetsV2SpreadsheetsBySpreadsheetTokenProtectedRangeBatchUpdateBodyDto.cs index d7a89b9e..91bbebe0 100644 --- a/src/Ccm.Spec/PostSheetsV2SpreadsheetsBySpreadsheetTokenProtectedRangeBatchUpdateBodyDto.cs +++ b/src/Ccm.Spec/PostSheetsV2SpreadsheetsBySpreadsheetTokenProtectedRangeBatchUpdateBodyDto.cs @@ -14,7 +14,8 @@ namespace FeishuNetSdk.Ccm.Spec; /// /// 修改保护范围 请求体 -/// 该接口用于根据保护范围ID修改保护范围,单次最多支持同时修改10个ID。 +/// 修改电子表格工作表中指定的保护范围。 +/// 使用限制:单次调用该接口,最多支持修改 10 个保护范围。 /// 接口ID:6923123667871612956 /// 文档地址:https://open.feishu.cn/document/server-docs/docs/sheets-v3/protect-range/modify-protection-scopes /// JSON地址:https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fukTMukTMukTM%2fuUTM5YjL1ETO24SNxkjN @@ -22,7 +23,7 @@ namespace FeishuNetSdk.Ccm.Spec; public record PostSheetsV2SpreadsheetsBySpreadsheetTokenProtectedRangeBatchUpdateBodyDto { /// - /// 请求 + /// 需要增加保护范围的维度信息。支持传入多个维度信息。 /// 必填:是 /// [JsonPropertyName("requests")] @@ -32,14 +33,14 @@ public record PostSheetsV2SpreadsheetsBySpreadsheetTokenProtectedRangeBatchUpdat public record Request { /// - /// 保护范围ID,可以通过[获取表格元数据](https://open.feishu.cn/document/ukTMukTMukTM/uETMzUjLxEzM14SMxMTN) 接口获取 + /// 保护范围 ID,可通过[获取表格元数据](https://open.feishu.cn/document/ukTMukTMukTM/uETMzUjLxEzM14SMxMTN) 获取。 /// 必填:是 /// [JsonPropertyName("protectId")] public string ProtectId { get; set; } = string.Empty; /// - /// 行列保护信息 + /// 要保护的行或列 /// 必填:否 /// [JsonPropertyName("dimension")] @@ -49,36 +50,38 @@ public record Request public record DimensionSuffix { /// - /// sheetId + /// 电子表格工作表的 ID。调用[获取工作表](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet/query)获取。 /// 必填:是 /// [JsonPropertyName("sheetId")] public string SheetId { get; set; } = string.Empty; /// - /// 保护行列起始下标,下标从1开始 + /// 保护范围的维度。可选值: + /// - ROWS:行 + /// - COLUMNS:列 /// 必填:是 /// - [JsonPropertyName("startIndex")] - public int StartIndex { get; set; } + [JsonPropertyName("majorDimension")] + public string MajorDimension { get; set; } = string.Empty; /// - /// 保护行列终止下标,下标从1开始 + /// 开始的行或列的索引。从 1 开始计数。若 `startIndex` 为 3,则从第 3 行或列开始保护。包含第 3 行或列。 /// 必填:是 /// - [JsonPropertyName("endIndex")] - public int EndIndex { get; set; } + [JsonPropertyName("startIndex")] + public int StartIndex { get; set; } /// - /// 保护范围ID对应的保护范围的维度,COLUMNS为保护列,ROWS为保护行 + /// 结束的行或列的索引。从 1 开始计数。若 `endIndex` 为 7,则保护到第 7 行或列。包含第 7 行或列。 /// 必填:是 /// - [JsonPropertyName("majorDimension")] - public string MajorDimension { get; set; } = string.Empty; + [JsonPropertyName("endIndex")] + public int EndIndex { get; set; } } /// - /// 可编辑保护范围的用户 + /// 增加或删除可编辑保护范围的用户 ID 列表 /// 必填:否 /// [JsonPropertyName("editors")] @@ -88,43 +91,46 @@ public record DimensionSuffix public record EditorsSuffix { /// - /// 需要增加的用户的列表,用户需要有文档的编辑权限 + /// 增加的用户 ID 列表,用户需要有文档的编辑权限。 /// 必填:否 /// [JsonPropertyName("addEditors")] public Editor[]? AddEditors { get; set; } - /// - /// 需要删除的用户的列表 - /// 必填:否 - /// - [JsonPropertyName("delEditors")] - public Editor[]? DelEditors { get; set; } - /// public record Editor { /// - /// 用户类型,支持userId,openId,unionId + /// 用户 ID 类型,可选值: + /// - userId:标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内,一个用户的 User ID 在所有应用(包括商店应用)中都保持一致。User ID 主要用于在不同的应用间打通用户数据。详情参考[如何获取 User ID](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-user-id) + /// - openId:标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。详情参考[如何获取 Open ID](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid) + /// - unionId:标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的,在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID,应用开发商可以把同个用户在多个应用中的身份关联起来。详情参考[如何获取 Union ID](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-union-id) /// 必填:是 /// [JsonPropertyName("memberType")] public string MemberType { get; set; } = string.Empty; /// - /// 用户类型对应的用户ID + /// 用户 ID,类型由 `memberType` 决定。 /// 必填:是 /// [JsonPropertyName("memberId")] public string MemberId { get; set; } = string.Empty; } + + /// + /// 需要删除的用户的列表 + /// 必填:否 + /// + [JsonPropertyName("delEditors")] + public Editor[]? DelEditors { get; set; } } /// - /// 保护说明 + /// 保护范围的备注信息 /// 必填:否 /// [JsonPropertyName("lockInfo")] public string? LockInfo { get; set; } } -} +} \ No newline at end of file diff --git a/src/Ccm.Spec/PostSheetsV2SpreadsheetsBySpreadsheetTokenProtectedRangeBatchUpdateResponseDto.cs b/src/Ccm.Spec/PostSheetsV2SpreadsheetsBySpreadsheetTokenProtectedRangeBatchUpdateResponseDto.cs index f4857d04..0726c61a 100644 --- a/src/Ccm.Spec/PostSheetsV2SpreadsheetsBySpreadsheetTokenProtectedRangeBatchUpdateResponseDto.cs +++ b/src/Ccm.Spec/PostSheetsV2SpreadsheetsBySpreadsheetTokenProtectedRangeBatchUpdateResponseDto.cs @@ -14,7 +14,8 @@ namespace FeishuNetSdk.Ccm.Spec; /// /// 修改保护范围 响应体 -/// 该接口用于根据保护范围ID修改保护范围,单次最多支持同时修改10个ID。 +/// 修改电子表格工作表中指定的保护范围。 +/// 使用限制:单次调用该接口,最多支持修改 10 个保护范围。 /// 接口ID:6923123667871612956 /// 文档地址:https://open.feishu.cn/document/server-docs/docs/sheets-v3/protect-range/modify-protection-scopes /// JSON地址:https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fukTMukTMukTM%2fuUTM5YjL1ETO24SNxkjN @@ -22,7 +23,7 @@ namespace FeishuNetSdk.Ccm.Spec; public record PostSheetsV2SpreadsheetsBySpreadsheetTokenProtectedRangeBatchUpdateResponseDto { /// - /// 响应 + /// 修改后的保护范围的信息 /// 必填:否 /// [JsonPropertyName("replies")] @@ -32,14 +33,21 @@ public record PostSheetsV2SpreadsheetsBySpreadsheetTokenProtectedRangeBatchUpdat public record Reply { /// - /// sheet的id + /// 保护范围 ID + /// 必填:否 + /// + [JsonPropertyName("protectId")] + public string? ProtectId { get; set; } + + /// + /// 工作表 ID /// 必填:否 /// [JsonPropertyName("sheetId")] - public string? Sheetid { get; set; } + public string? SheetId { get; set; } /// - /// 成功修改的保护行列信息 + /// 保护的行或列 /// 必填:否 /// [JsonPropertyName("dimension")] @@ -49,28 +57,30 @@ public record Reply public record DimensionSuffix { /// - /// sheetId + /// 电子表格工作表的 ID /// 必填:否 /// [JsonPropertyName("sheetId")] public string? SheetId { get; set; } /// - /// 保护行列起始下标,下标从1开始 + /// 开始的行或列的索引。从 1 开始计数。若 startIndex 为 3,则从第 3 行或列开始保护。包含第 3 行或列。 /// 必填:否 /// [JsonPropertyName("startIndex")] public int? StartIndex { get; set; } /// - /// 保护行列终止下标,下标从1开始 + /// 结束的行或列的索引。从 1 开始计数。若 endIndex 为 7,则保护到第 7 行或列。包含第 7 行或列。 /// 必填:否 /// [JsonPropertyName("endIndex")] public int? EndIndex { get; set; } /// - /// 保护范围的维度 + /// 保护范围的维度。枚举值: + /// - ROWS:行 + /// - COLUMNS:列 /// 必填:否 /// [JsonPropertyName("majorDimension")] @@ -78,7 +88,7 @@ public record DimensionSuffix } /// - /// 可编辑保护范围的用户 + /// 增加或删除的可编辑保护范围的用户 ID 列表 /// 必填:否 /// [JsonPropertyName("editors")] @@ -88,44 +98,43 @@ public record DimensionSuffix public record EditorsSuffix { /// - /// 成功增加的用户的列表 + /// 增加的用户 ID 列表 /// 必填:否 /// [JsonPropertyName("addEditors")] public Editor[]? AddEditors { get; set; } - - /// - /// 成功删除的用户的列表 - /// 必填:否 - /// - [JsonPropertyName("delEditors")] - public Editor[]? DelEditors { get; set; } - /// public record Editor { /// - /// 用户类型 + /// 用户 ID 类型 /// 必填:否 /// [JsonPropertyName("memberType")] public string? MemberType { get; set; } /// - /// 用户类型对应的用户ID + /// 用户 ID,类型由 memberType 决定。 /// 必填:否 /// [JsonPropertyName("memberId")] public string? MemberId { get; set; } } + + /// + /// 删除的用户的列表 + /// 必填:否 + /// + [JsonPropertyName("delEditors")] + public Editor[]? DelEditors { get; set; } } /// - /// 成功修改的保护说明 + /// 修改的备注信息 /// 必填:否 /// [JsonPropertyName("lockInfo")] public string? LockInfo { get; set; } } -} +} \ No newline at end of file diff --git a/src/Ccm.Spec/PutSheetsV2SpreadsheetsBySpreadsheetTokenDataValidationBySheetIdByDataValidationIdBodyDto.cs b/src/Ccm.Spec/PutSheetsV2SpreadsheetsBySpreadsheetTokenDataValidationBySheetIdByDataValidationIdBodyDto.cs index 5fd25682..cda1b303 100644 --- a/src/Ccm.Spec/PutSheetsV2SpreadsheetsBySpreadsheetTokenDataValidationBySheetIdByDataValidationIdBodyDto.cs +++ b/src/Ccm.Spec/PutSheetsV2SpreadsheetsBySpreadsheetTokenDataValidationBySheetIdByDataValidationIdBodyDto.cs @@ -14,7 +14,7 @@ namespace FeishuNetSdk.Ccm.Spec; /// /// 更新下拉列表设置 请求体 -/// 该接口根据 spreadsheetToken 、sheetId、dataValidationId 更新下拉列表的属性。 +/// 更新电子表格工作表中单个下拉列表的设置,支持更新下拉列表的选项和属性,包括是否支持多选、下拉选项的样式等。 /// 接口ID:6943917246700322818 /// 文档地址:https://open.feishu.cn/document/server-docs/docs/sheets-v3/datavalidation/update-datavalidation /// JSON地址:https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fukTMukTMukTM%2fuATMzUjLwEzM14CMxMTN%2fdatavalidation%2fupdate-datavalidation @@ -22,7 +22,7 @@ namespace FeishuNetSdk.Ccm.Spec; public record PutSheetsV2SpreadsheetsBySpreadsheetTokenDataValidationBySheetIdByDataValidationIdBodyDto { /// - /// 下拉列表填"list" + /// 数据验证的类型。支持下拉列表,请填写 "list"。 /// 必填:是 /// [JsonPropertyName("dataValidationType")] @@ -30,23 +30,28 @@ public record PutSheetsV2SpreadsheetsBySpreadsheetTokenDataValidationBySheetIdBy /// /// 下拉列表规则属性 - /// 必填:否 + /// 必填:是 /// [JsonPropertyName("dataValidation")] - public DataValidationSuffix? DataValidation { get; set; } + public DataValidationSuffix DataValidation { get; set; } = new(); /// public record DataValidationSuffix { /// - /// 下拉列表选项值, 需为字符串,不能包含",",选项值最长100字符,选项个数最多500个 + /// 下拉列表选项的值 + /// **数据校验规则**: + /// - 单个值需为字符串类型且不能包含 "," + /// - 单个值的长度不可超过 100 字节 + /// - 选项值的个数不可超过 500 个 + /// **示例值**:["2", "89", "3","2"] /// 必填:是 /// [JsonPropertyName("conditionValues")] public string[] ConditionValues { get; set; } = Array.Empty(); /// - /// 可选属性 + /// 下拉选项其它配置,包括是否支持多选、是否设置下拉选项样式等。 /// 必填:否 /// [JsonPropertyName("options")] @@ -56,21 +61,28 @@ public record DataValidationSuffix public record Option { /// - /// 单选填false, 多选填true,不填默认为false + /// 是否支持多选选项。可选值: + /// - false:不支持多选 + /// - true:支持多选 + /// **默认值**:false,即不支持多选选项 /// 必填:否 /// [JsonPropertyName("multipleValues")] public bool? MultipleValues { get; set; } /// - /// 是否设置颜色和胶囊样式, 不填默认为false + /// 是否为下拉选项设置颜色。可选值: + /// - false:不设置颜色 + /// - true:为下拉选项设置颜色。需进一步配置 colors 参数 + /// **默认值**:false,即不设置颜色 /// 必填:否 /// [JsonPropertyName("highlightValidData")] public bool? HighlightValidData { get; set; } /// - /// 当highlightValidData为true时,color需填颜色,与conditionValues中的值一一对应。需是RGB16进制格式,如"#fffd00" + /// 指定下拉选项的颜色。格式为 RGB 十六进制,如 "#fffd00"。当 `highlightValidData` 为 true 时,该参数必填。颜色将与 conditionValues 中的值按顺序一一对应。 + /// **示例值**:["#1FB6C1", "#F006C2", "#FB16C3","#FFB6C1"] /// 必填:否 /// [JsonPropertyName("colors")] diff --git a/src/Ccm.Spec/PutSheetsV2SpreadsheetsBySpreadsheetTokenDataValidationBySheetIdByDataValidationIdResponseDto.cs b/src/Ccm.Spec/PutSheetsV2SpreadsheetsBySpreadsheetTokenDataValidationBySheetIdByDataValidationIdResponseDto.cs index cf9aed0d..7f2ddfb5 100644 --- a/src/Ccm.Spec/PutSheetsV2SpreadsheetsBySpreadsheetTokenDataValidationBySheetIdByDataValidationIdResponseDto.cs +++ b/src/Ccm.Spec/PutSheetsV2SpreadsheetsBySpreadsheetTokenDataValidationBySheetIdByDataValidationIdResponseDto.cs @@ -14,7 +14,7 @@ namespace FeishuNetSdk.Ccm.Spec; /// /// 更新下拉列表设置 响应体 -/// 该接口根据 spreadsheetToken 、sheetId、dataValidationId 更新下拉列表的属性。 +/// 更新电子表格工作表中单个下拉列表的设置,支持更新下拉列表的选项和属性,包括是否支持多选、下拉选项的样式等。 /// 接口ID:6943917246700322818 /// 文档地址:https://open.feishu.cn/document/server-docs/docs/sheets-v3/datavalidation/update-datavalidation /// JSON地址:https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fukTMukTMukTM%2fuATMzUjLwEzM14CMxMTN%2fdatavalidation%2fupdate-datavalidation @@ -22,20 +22,23 @@ namespace FeishuNetSdk.Ccm.Spec; public record PutSheetsV2SpreadsheetsBySpreadsheetTokenDataValidationBySheetIdByDataValidationIdResponseDto { /// - /// spreadsheet的token - /// 必填:是 + /// 电子表格的 token + /// 必填:否 /// [JsonPropertyName("spreadsheetToken")] - public string SpreadsheetToken { get; set; } = string.Empty; + public string? SpreadsheetToken { get; set; } /// - /// 工作表 sheet 的 id - /// 必填:是 + /// 工作表的 ID + /// 必填:否 /// [JsonPropertyName("sheetId")] - public string SheetId { get; set; } = string.Empty; + public string? SheetId { get; set; } - /// + /// + /// 下拉列表规则的属性 + /// 必填:否 + /// [JsonPropertyName("dataValidation")] public DataValidationSuffix? DataValidation { get; set; } @@ -43,28 +46,28 @@ public record PutSheetsV2SpreadsheetsBySpreadsheetTokenDataValidationBySheetIdBy public record DataValidationSuffix { /// - /// 唯一标示id - /// 必填:是 + /// 下拉列表的 ID + /// 必填:否 /// [JsonPropertyName("dataValidationId")] - public int DataValidationId { get; set; } + public int? DataValidationId { get; set; } /// - /// 下拉列表为"list" - /// 必填:是 + /// 数据验证的类型。下拉列表为 "list"。 + /// 必填:否 /// [JsonPropertyName("dataValidationType")] - public string DataValidationType { get; set; } = string.Empty; + public string? DataValidationType { get; set; } /// - /// 下拉列表选项值 - /// 必填:是 + /// 下拉列表选项的值 + /// 必填:否 /// [JsonPropertyName("conditionValues")] - public string[] ConditionValues { get; set; } = Array.Empty(); + public string[]? ConditionValues { get; set; } /// - /// 可选属性 + /// 下拉选项其它配置,包括是否支持多选、是否设置下拉选项样式等。 /// 必填:否 /// [JsonPropertyName("options")] @@ -74,25 +77,29 @@ public record DataValidationSuffix public record Option { /// - /// 单选填false, 多选填true + /// 是否支持多选选项。可选值: + /// - false:不支持多选 + /// - true:支持多选 /// 必填:否 /// [JsonPropertyName("multipleValues")] public bool? MultipleValues { get; set; } /// - /// 是否设置颜色和胶囊样式 + /// 是否为下拉选项设置颜色。可选值: + /// - false:不设置颜色 + /// - true:为下拉选项设置颜色 /// 必填:否 /// [JsonPropertyName("highlightValidData")] public bool? HighlightValidData { get; set; } /// - /// 当highlightValidData为true时,colorValueMap的key与conditionValues中的值一一对应,value为对应的颜色参数。 + /// 指定的下拉选项的颜色。格式为 RGB 十六进制,如 "#fffd00"。颜色将与 conditionValues 中的值按顺序一一对应。 /// 必填:否 /// [JsonPropertyName("colorValueMap")] public Dictionary? ColorValueMap { get; set; } } } -} +} \ No newline at end of file diff --git a/src/Ccm/PostDriveV1FilesByFileTokenVersionsBodyDto.cs b/src/Ccm/PostDriveV1FilesByFileTokenVersionsBodyDto.cs index eb1110e9..25c916e2 100644 --- a/src/Ccm/PostDriveV1FilesByFileTokenVersionsBodyDto.cs +++ b/src/Ccm/PostDriveV1FilesByFileTokenVersionsBodyDto.cs @@ -25,16 +25,16 @@ public record PostDriveV1FilesByFileTokenVersionsBodyDto /// 创建的版本文档的标题。 /// 最大长度 1024 个 Unicode 码点。通常情况下,一个英文或中文字符对应一个码点,但是某些特殊符号可能会对应多个码点。例如,家庭组合「👨‍👩‍👧」这个表情符号对应 5 个码点。 /// **注意**:该参数必填,请忽略左侧必填列显示的“否”。 - /// 必填:否 + /// 必填:是 /// 示例值:项目文档 第 1 版 /// [JsonPropertyName("name")] - public string? Name { get; set; } + public string Name { get; set; } = string.Empty; /// /// 源文档的类型 /// **注意**:该参数必填,请忽略左侧必填列显示的“否”。 - /// 必填:否 + /// 必填:是 /// 示例值:docx /// 可选值: /// docx:新版文档 @@ -42,5 +42,5 @@ public record PostDriveV1FilesByFileTokenVersionsBodyDto /// /// [JsonPropertyName("obj_type")] - public string? ObjType { get; set; } + public string ObjType { get; set; } = string.Empty; } diff --git a/src/Corehr/PatchCorehrV2PreHiresByPreHireIdBodyDto.cs b/src/Corehr/PatchCorehrV2PreHiresByPreHireIdBodyDto.cs index 42aa711e..3d75adcf 100644 --- a/src/Corehr/PatchCorehrV2PreHiresByPreHireIdBodyDto.cs +++ b/src/Corehr/PatchCorehrV2PreHiresByPreHireIdBodyDto.cs @@ -643,7 +643,7 @@ public record NationalIdForUpdate public string? Employer { get; set; } /// - /// 岗位 + /// 岗位信息描述 /// 必填:否 /// 示例值:保安 /// @@ -1505,7 +1505,7 @@ public record ObjectFieldData public string FieldName { get; set; } = string.Empty; /// - /// 字段值,是json转义后的字符串,根据元数据定义不同,字段格式不同(123, 123.23, true, [\"id1\",\"id2\], 2006-01-02 15:04:05]) + /// 字段值,是json转义后的字符串,根据元数据定义不同,字段格式不同(123, 123.23, true, [\"id1\",\"id2\], 2006-01-02 15:04:05) /// 必填:是 /// 示例值:Sandy /// @@ -1668,14 +1668,14 @@ public record EmailForUpdate } /// - /// 成本中心分摊信息,只支持商业化租户 + /// 成本中心分摊信息(仅支持部门开通成本中心功能的租户) /// 必填:否 /// [JsonPropertyName("cost_center_rates")] public JobDataCostCenter[]? CostCenterRates { get; set; } /// - /// 成本中心分摊信息,只支持商业化租户 + /// 成本中心分摊信息(仅支持部门开通成本中心功能的租户) /// public record JobDataCostCenter { @@ -1742,7 +1742,7 @@ public record ObjectFieldData public int? ProbationPeriod { get; set; } /// - /// 试用期开始日期 + /// 试用期开始日期,格式:"YYYY-MM-DD" /// 必填:否 /// 示例值:2022-07-29 /// @@ -1750,7 +1750,7 @@ public record ObjectFieldData public string? ProbationStartDate { get; set; } /// - /// 试用期结束日期 + /// 试用期结束日期,格式:"YYYY-MM-DD" /// 必填:否 /// 示例值:2023-04-07 /// @@ -1758,7 +1758,7 @@ public record ObjectFieldData public string? ProbationEndDate { get; set; } /// - /// 合同开始日期 + /// 合同开始日期,格式:"YYYY-MM-DD" /// 必填:否 /// 示例值:2022-10-08 /// @@ -1766,7 +1766,7 @@ public record ObjectFieldData public string? ContractStartDate { get; set; } /// - /// 合同结束日期 + /// 合同结束日期,格式:"YYYY-MM-DD" /// 必填:否 /// 示例值:2025-10-07 /// @@ -1812,7 +1812,7 @@ public record ObjectFieldData public string? WorkerId { get; set; } /// - /// 签到日期 + /// 签到日期,格式:"YYYY-MM-DD" /// 必填:否 /// 示例值:2024-12-31 /// @@ -1876,7 +1876,7 @@ public record ObjectFieldData public string? PayGroupId { get; set; } /// - /// Offer HR ID,可以通过[批量查询员工信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)接口获取 + /// Offer HR 雇佣ID,可以通过[批量查询员工信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)接口获取 /// 必填:否 /// 示例值:7032210902531327521 /// diff --git a/src/Corehr/PostCorehrV2EmployeesBatchGetBodyDto.cs b/src/Corehr/PostCorehrV2EmployeesBatchGetBodyDto.cs index 87bf2ff9..637dffc3 100644 --- a/src/Corehr/PostCorehrV2EmployeesBatchGetBodyDto.cs +++ b/src/Corehr/PostCorehrV2EmployeesBatchGetBodyDto.cs @@ -22,7 +22,9 @@ namespace FeishuNetSdk.Corehr; public record PostCorehrV2EmployeesBatchGetBodyDto { /// - /// 期望获取到的字段列表,填写方式:为空时默认仅返回 employment id;可基于响应体 json 路径传递。 + /// 需要查询的字段列表 + /// - 可参考响应体的结构,选择需要查询的字段填入 + /// - 为空时仅返回 employment_id /// 必填:否 /// 最大长度:100 /// diff --git a/src/Corehr/PostCorehrV2EmployeesBatchGetResponseDto.cs b/src/Corehr/PostCorehrV2EmployeesBatchGetResponseDto.cs index 501054f2..dc162023 100644 --- a/src/Corehr/PostCorehrV2EmployeesBatchGetResponseDto.cs +++ b/src/Corehr/PostCorehrV2EmployeesBatchGetResponseDto.cs @@ -940,7 +940,7 @@ public record Enum /// /// 枚举值 /// 必填:是 - /// 示例值:phone_type + /// 示例值:employee /// [JsonPropertyName("enum_name")] public string EnumName { get; set; } = string.Empty; @@ -1040,7 +1040,7 @@ public record Enum /// /// 枚举值 /// 必填:是 - /// 示例值:phone_type + /// 示例值:home /// [JsonPropertyName("enum_name")] public string EnumName { get; set; } = string.Empty; @@ -1235,7 +1235,7 @@ public record Enum /// /// 枚举值 /// 必填:是 - /// 示例值:phone_type + /// 示例值:legal_name /// [JsonPropertyName("enum_name")] public string EnumName { get; set; } = string.Empty; @@ -1447,7 +1447,7 @@ public record Enum /// /// 枚举值 /// 必填:是 - /// 示例值:phone_type + /// 示例值:male /// [JsonPropertyName("enum_name")] public string EnumName { get; set; } = string.Empty; @@ -1539,7 +1539,7 @@ public record Enum /// /// 枚举值 /// 必填:是 - /// 示例值:phone_type + /// 示例值:86_china /// [JsonPropertyName("enum_name")] public string EnumName { get; set; } = string.Empty; @@ -1840,7 +1840,7 @@ public record Enum /// /// 枚举值 /// 必填:是 - /// 示例值:phone_type + /// 示例值:home_address /// [JsonPropertyName("enum_name")] public string EnumName { get; set; } = string.Empty; @@ -2009,7 +2009,7 @@ public record Enum /// /// 枚举值 /// 必填:是 - /// 示例值:phone_type + /// 示例值:home /// [JsonPropertyName("enum_name")] public string EnumName { get; set; } = string.Empty; @@ -2204,6 +2204,8 @@ public record Education { /// /// 学校 + /// - 自定义名称时返回该字段 + /// - 下拉框选择的返回 school_name 字段 /// 必填:是 /// [JsonPropertyName("school")] @@ -2211,6 +2213,8 @@ public record Education /// /// 学校 + /// - 自定义名称时返回该字段 + /// - 下拉框选择的返回 school_name 字段 /// public record I18n { @@ -2246,7 +2250,7 @@ public record Enum /// /// 枚举值 /// 必填:是 - /// 示例值:phone_type + /// 示例值:phd /// [JsonPropertyName("enum_name")] public string EnumName { get; set; } = string.Empty; @@ -2299,6 +2303,8 @@ public record I18n /// /// 专业 + /// - 自定义名称时返回该字段 + /// - 下拉框选择的返回 field_of_study_name 字段 /// 必填:否 /// [JsonPropertyName("field_of_study")] @@ -2312,18 +2318,24 @@ public record I18n public Enum? Degree { get; set; } /// - /// 学校名称,可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)获取,查询参数: + /// 学校名称 + /// - 可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)获取,查询参数: /// - custom_api_name:school_name /// - object_api_name:education + /// - 自定义名称时返回 school 字段 + /// - 下拉框选择的返回该字段 /// 必填:否 /// [JsonPropertyName("school_name")] public Enum? SchoolName { get; set; } /// - /// 专业名称,可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)获取,查询参数: + /// 专业名称 + /// - 可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)获取,查询参数: /// - custom_api_name:field_of_study_name /// - object_api_name:education + /// - 自定义名称时返回 field_of_study 字段 + /// - 下拉框选择的返回该字段 /// 必填:否 /// [JsonPropertyName("field_of_study_name")] @@ -2495,7 +2507,7 @@ public record Enum /// /// 枚举值 /// 必填:是 - /// 示例值:phone_type + /// 示例值:payment /// [JsonPropertyName("enum_name")] public string EnumName { get; set; } = string.Empty; @@ -2810,7 +2822,7 @@ public record Enum /// /// 枚举值 /// 必填:是 - /// 示例值:phone_type + /// 示例值:legal_name /// [JsonPropertyName("enum_name")] public string EnumName { get; set; } = string.Empty; @@ -3016,7 +3028,7 @@ public record Enum /// /// 枚举值 /// 必填:是 - /// 示例值:phone_type + /// 示例值:parent /// [JsonPropertyName("enum_name")] public string EnumName { get; set; } = string.Empty; @@ -3349,7 +3361,7 @@ public record Enum /// /// 枚举值 /// 必填:是 - /// 示例值:phone_type + /// 示例值:86_china /// [JsonPropertyName("enum_name")] public string EnumName { get; set; } = string.Empty; @@ -3650,7 +3662,7 @@ public record Enum /// /// 枚举值 /// 必填:是 - /// 示例值:phone_type + /// 示例值:home_address /// [JsonPropertyName("enum_name")] public string EnumName { get; set; } = string.Empty; @@ -3861,7 +3873,7 @@ public record Enum /// /// 枚举值 /// 必填:是 - /// 示例值:phone_type + /// 示例值:legal_name /// [JsonPropertyName("enum_name")] public string EnumName { get; set; } = string.Empty; @@ -4069,7 +4081,7 @@ public record Enum /// /// 枚举值 /// 必填:是 - /// 示例值:phone_type + /// 示例值:parent /// [JsonPropertyName("enum_name")] public string EnumName { get; set; } = string.Empty; @@ -4135,7 +4147,7 @@ public record Enum /// /// 枚举值 /// 必填:是 - /// 示例值:phone_type + /// 示例值:86_china /// [JsonPropertyName("enum_name")] public string EnumName { get; set; } = string.Empty; @@ -4384,7 +4396,7 @@ public record Enum /// /// 枚举值 /// 必填:是 - /// 示例值:phone_type + /// 示例值:example /// [JsonPropertyName("enum_name")] public string EnumName { get; set; } = string.Empty; @@ -4659,7 +4671,7 @@ public record Enum /// /// 枚举值 /// 必填:是 - /// 示例值:phone_type + /// 示例值:example /// [JsonPropertyName("enum_name")] public string EnumName { get; set; } = string.Empty; diff --git a/src/Corehr/PostCorehrV2EmployeesJobDatasBatchGetBodyDto.cs b/src/Corehr/PostCorehrV2EmployeesJobDatasBatchGetBodyDto.cs index f0151088..80e19103 100644 --- a/src/Corehr/PostCorehrV2EmployeesJobDatasBatchGetBodyDto.cs +++ b/src/Corehr/PostCorehrV2EmployeesJobDatasBatchGetBodyDto.cs @@ -23,7 +23,7 @@ public record PostCorehrV2EmployeesJobDatasBatchGetBodyDto { /// /// 员工雇佣 ID 列表,可通过[【搜索员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/search)获取 - /// 应与 user_id_type 类型一致 + /// - 应与 user_id_type 类型一致 /// 必填:是 /// 最大长度:100 /// 最小长度:1 @@ -32,7 +32,10 @@ public record PostCorehrV2EmployeesJobDatasBatchGetBodyDto public string[] EmploymentIds { get; set; } = Array.Empty(); /// - /// 是否获取所有任职记录,true 为获取员工所有版本的任职记录,false 为仅获取当前生效的任职记录,默认为 false + /// 是否获取所有版本的任职记录 + /// - true 为获取员工所有版本的任职记录 + /// - false 为仅获取当前生效的任职记录 + /// - 默认为 false /// 必填:否 /// 示例值:false /// @@ -41,6 +44,7 @@ public record PostCorehrV2EmployeesJobDatasBatchGetBodyDto /// /// 生效日期 - 搜索范围开始 + /// - 默认为空 /// 必填:否 /// 示例值:2020-01-01 /// @@ -49,6 +53,7 @@ public record PostCorehrV2EmployeesJobDatasBatchGetBodyDto /// /// 生效日期 - 搜索范围结束 + /// - 默认为空 /// 必填:否 /// 示例值:2020-01-01 /// @@ -56,7 +61,8 @@ public record PostCorehrV2EmployeesJobDatasBatchGetBodyDto public string? EffectiveDateEnd { get; set; } /// - /// 查看数据日期,默认为今天 + /// 查看数据日期 + /// - 默认为当天 /// 必填:否 /// 示例值:2020-01-01 /// diff --git a/src/Corehr/PostCorehrV2EmployeesJobDatasBatchGetResponseDto.cs b/src/Corehr/PostCorehrV2EmployeesJobDatasBatchGetResponseDto.cs index 2ecdee6d..ef9bce5f 100644 --- a/src/Corehr/PostCorehrV2EmployeesJobDatasBatchGetResponseDto.cs +++ b/src/Corehr/PostCorehrV2EmployeesJobDatasBatchGetResponseDto.cs @@ -22,19 +22,20 @@ namespace FeishuNetSdk.Corehr; public record PostCorehrV2EmployeesJobDatasBatchGetResponseDto { /// - /// 查询的雇佣信息 + /// 查询的任职信息 /// 必填:否 /// [JsonPropertyName("items")] public EmployeeJobData[]? Items { get; set; } /// - /// 查询的雇佣信息 + /// 查询的任职信息 /// public record EmployeeJobData { /// - /// Employment ID + /// 员工雇佣ID,可通过[【批量查询员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息 + /// - 与 user_id_type 类型一致 /// 必填:是 /// 示例值:6893014062142064135 /// @@ -42,7 +43,7 @@ public record EmployeeJobData public string EmploymentId { get; set; } = string.Empty; /// - /// 实体在 CoreHR 内部的唯一键 + /// 任职记录 /// 必填:否 /// 示例值:6890452208593372679 /// @@ -50,7 +51,7 @@ public record EmployeeJobData public JobData[]? JobDatas { get; set; } /// - /// 实体在 CoreHR 内部的唯一键 + /// 任职记录 /// public record JobData { @@ -71,7 +72,7 @@ public record JobData public string? VersionId { get; set; } /// - /// 人员类型 ID,枚举值及详细信息可通过[查询单个人员类型](https://open.feishu.cn/document/server-docs/corehr-v1/basic-infomation/employee_type/get)接口查询获得 + /// 人员类型 ID,可通过[【查询单个人员类型】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/employee_type/get)获取详细信息 /// 必填:是 /// 示例值:6890452208593372679 /// @@ -79,7 +80,7 @@ public record JobData public string EmployeeTypeId { get; set; } = string.Empty; /// - /// 工时制度 ID,枚举值及详细信息可通过[查询单个工时制度](https://open.feishu.cn/document/server-docs/corehr-v1/basic-infomation/working_hours_type/get)接口查询获得 + /// 工时制度 ID,可通过[【查询单个工时制度】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/working_hours_type/get)获取详细信息 /// 必填:否 /// 示例值:6890452208593372679 /// @@ -87,7 +88,7 @@ public record JobData public string? WorkingHoursTypeId { get; set; } /// - /// 工作地点 ID,枚举值及详细信息可通过[查询单个地点](https://open.feishu.cn/document/server-docs/corehr-v1/organization-management/location/get)接口查询获得 + /// 工作地点 ID,可通过[【查询单个地点】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/location/get)获取详细信息 /// 必填:否 /// 示例值:6890452208593372679 /// @@ -95,8 +96,8 @@ public record JobData public string? WorkLocationId { get; set; } /// - /// 部门 ID,枚举值及详细信息可通过[查询单个部门](https://open.feishu.cn/document/server-docs/corehr-v1/organization-management/department/get)接口查询获得 - /// 与 department_id_type 类型一致 + /// 部门 ID,可通过[【查询单个部门】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/department/get)获取详细信息 + /// - 与 department_id_type 类型一致 /// 必填:否 /// 示例值:6890452208593372679 /// @@ -104,8 +105,7 @@ public record JobData public string? DepartmentId { get; set; } /// - /// 岗位 ID,详细信息可通过【查询岗位】 - /// 接口查询获得 + /// 岗位 ID,功能灰度中,如有需要请联系[技术支持](https://applink.feishu.cn/TLJpeNdW) /// 必填:否 /// 示例值:6890452208593372679 /// @@ -113,7 +113,7 @@ public record JobData public string? PositionId { get; set; } /// - /// 职务 ID,枚举值及详细信息可通过[查询单个职务](https://open.feishu.cn/document/server-docs/corehr-v1/job-management/job/get)接口查询获得 + /// 职务 ID,可通过[【查询单个职务】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job/get)获取详细信息 /// 必填:否 /// 示例值:6890452208593372679 /// @@ -121,7 +121,7 @@ public record JobData public string? JobId { get; set; } /// - /// 职级 ID,枚举值及详细信息可通过[查询单个职级](https://open.feishu.cn/document/server-docs/corehr-v1/job-management/job_level/get)接口查询获得 + /// 职级 ID,可通过[【查询单个职级】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_level/get)获取详细信息 /// 必填:否 /// 示例值:6890452208593372679 /// @@ -129,7 +129,7 @@ public record JobData public string? JobLevelId { get; set; } /// - /// 职等 ID + /// 职等 ID,可通过[【查询职等】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job_grade/query)获取详细信息 /// 必填:否 /// 示例值:6890452208593372679 /// @@ -137,7 +137,7 @@ public record JobData public string? JobGradeId { get; set; } /// - /// 序列 ID,枚举值及详细信息可通过[查询单个序列](https://open.feishu.cn/document/server-docs/corehr-v1/job-management/job_family/get)接口查询获得 + /// 序列 ID,可通过[【查询单个序列】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_family/get)获取详细信息 /// 必填:否 /// 示例值:1245678 /// @@ -170,7 +170,7 @@ public record JobData /// /// 雇佣 ID,可通过[【批量查询员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息 - /// 与 user_id_type 类型一致 + /// - 与 user_id_type 类型一致 /// 必填:是 /// 示例值:6893014062142064135 /// @@ -194,7 +194,8 @@ public record JobData public string? ExpirationTime { get; set; } /// - /// 任职原因,枚举值可通过文档[枚举常量介绍](https://open.feishu.cn/document/server-docs/corehr-v1/feishu-people-enum-constant)任职原因(assignment_start_reason)枚举定义部分获得 + /// 任职原因,枚举值可通过文档[【飞书人事枚举常量】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/feishu-people-enum-constant) + /// 任职原因(assignment_start_reason)枚举定义部分获得 /// 必填:否 /// 示例值:onboarding /// @@ -202,14 +203,15 @@ public record JobData public Enum? AssignmentStartReason { get; set; } /// - /// 任职原因,枚举值可通过文档[枚举常量介绍](https://open.feishu.cn/document/server-docs/corehr-v1/feishu-people-enum-constant)任职原因(assignment_start_reason)枚举定义部分获得 + /// 任职原因,枚举值可通过文档[【飞书人事枚举常量】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/feishu-people-enum-constant) + /// 任职原因(assignment_start_reason)枚举定义部分获得 /// public record Enum { /// /// 枚举值 /// 必填:是 - /// 示例值:phone_type + /// 示例值:onboarding /// [JsonPropertyName("enum_name")] public string EnumName { get; set; } = string.Empty; @@ -253,7 +255,8 @@ public record I18n public string? ProbationExpectedEndDate { get; set; } /// - /// 试用期结果,枚举值可通过文档[枚举常量介绍](https://open.feishu.cn/document/server-docs/corehr-v1/feishu-people-enum-constant)试用期结果(probation_outcome)枚举定义部分获得 + /// 试用期结果,枚举值可通过文档[【飞书人事枚举常量】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/feishu-people-enum-constant) + /// 试用期结果(probation_outcome)枚举定义部分获得 /// 必填:否 /// 示例值:passed /// @@ -283,7 +286,7 @@ public record BasicJobData /// /// 雇佣 ID,可通过[【批量查询员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息 - /// 与 user_id_type 类型一致 + /// - 与 user_id_type 类型一致 /// 必填:否 /// 示例值:6893014062142064135 /// @@ -319,7 +322,9 @@ public record BasicJobData public record JobDataCostCenter { /// - /// 成本中心 ID,可以通过[搜索成本中心信息](https://open.feishu.cn/document/server-docs/corehr-v1/organization-management/cost_center/search)接口获取对应的成本中心信息 + /// 成本中心 ID,可以通过 + /// [【搜索成本中心信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/cost_center/search) + /// 接口获取对应的成本中心信息 /// 必填:否 /// 示例值:6950635856373745165 /// @@ -362,7 +367,7 @@ public record JobDataCostCenter public string? ServiceCompany { get; set; } /// - /// 创建时间 + /// 创建时间,格式:2020-05-02 00:00:00 /// 必填:否 /// 示例值:2020-05-02 00:00:00 /// diff --git a/src/Corehr/PostCorehrV2EmployeesJobDatasQueryBodyDto.cs b/src/Corehr/PostCorehrV2EmployeesJobDatasQueryBodyDto.cs index 32adcf85..ea923c5b 100644 --- a/src/Corehr/PostCorehrV2EmployeesJobDatasQueryBodyDto.cs +++ b/src/Corehr/PostCorehrV2EmployeesJobDatasQueryBodyDto.cs @@ -22,7 +22,10 @@ namespace FeishuNetSdk.Corehr; public record PostCorehrV2EmployeesJobDatasQueryBodyDto { /// - /// 是否获取所有任职记录,true 为获取员工所有版本的任职记录,false 为仅获取当前生效的任职记录,默认为 false + /// 是否获取所有版本的任职记录 + /// - true 为获取员工所有版本的任职记录 + /// - false 为仅获取当前生效的任职记录 + /// - 默认为 false /// 必填:否 /// 示例值:false /// @@ -31,6 +34,8 @@ public record PostCorehrV2EmployeesJobDatasQueryBodyDto /// /// 查看数据日期 + /// - 与时间范围筛选为 AND 关系 + /// - 默认为当天 /// 必填:否 /// 示例值:2020-01-01 /// @@ -39,6 +44,7 @@ public record PostCorehrV2EmployeesJobDatasQueryBodyDto /// /// 生效日期 - 搜索范围开始 + /// - 默认为空 /// 必填:否 /// 示例值:2020-01-01 /// @@ -47,6 +53,7 @@ public record PostCorehrV2EmployeesJobDatasQueryBodyDto /// /// 生效日期 - 搜索范围结束 + /// - 默认为空 /// 必填:否 /// 示例值:2020-01-01 /// diff --git a/src/Corehr/PostCorehrV2EmployeesJobDatasQueryResponseDto.cs b/src/Corehr/PostCorehrV2EmployeesJobDatasQueryResponseDto.cs index c0302e7a..d13601b7 100644 --- a/src/Corehr/PostCorehrV2EmployeesJobDatasQueryResponseDto.cs +++ b/src/Corehr/PostCorehrV2EmployeesJobDatasQueryResponseDto.cs @@ -34,7 +34,8 @@ public record PostCorehrV2EmployeesJobDatasQueryResponseDto public record EmployeeJobData { /// - /// Employment ID + /// 员工雇佣 ID + /// - 类型与 user_id_type 一致 /// 必填:是 /// 示例值:6893014062142064135 /// @@ -42,7 +43,7 @@ public record EmployeeJobData public string EmploymentId { get; set; } = string.Empty; /// - /// 实体在 CoreHR 内部的唯一键 + /// 任职记录 /// 必填:否 /// 示例值:6890452208593372679 /// @@ -50,7 +51,7 @@ public record EmployeeJobData public JobData[]? JobDatas { get; set; } /// - /// 实体在 CoreHR 内部的唯一键 + /// 任职记录 /// public record JobData { @@ -71,7 +72,7 @@ public record JobData public string? VersionId { get; set; } /// - /// 人员类型 ID,枚举值及详细信息可通过[查询单个人员类型](https://open.feishu.cn/document/server-docs/corehr-v1/basic-infomation/employee_type/get)接口查询获得 + /// 人员类型 ID,可通过[【查询单个人员类型】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/employee_type/get)获取详细信息 /// 必填:是 /// 示例值:6890452208593372679 /// @@ -79,7 +80,7 @@ public record JobData public string EmployeeTypeId { get; set; } = string.Empty; /// - /// 工时制度 ID,枚举值及详细信息可通过[查询单个工时制度](https://open.feishu.cn/document/server-docs/corehr-v1/basic-infomation/working_hours_type/get)接口查询获得 + /// 工时制度 ID,可通过[【查询单个工时制度】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/working_hours_type/get)获取详细信息 /// 必填:否 /// 示例值:6890452208593372679 /// @@ -87,7 +88,7 @@ public record JobData public string? WorkingHoursTypeId { get; set; } /// - /// 工作地点 ID,枚举值及详细信息可通过[查询单个地点](https://open.feishu.cn/document/server-docs/corehr-v1/organization-management/location/get)接口查询获得 + /// 工作地点 ID,可通过[【查询单个地点】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/location/get)获取详细信息 /// 必填:否 /// 示例值:6890452208593372679 /// @@ -95,8 +96,8 @@ public record JobData public string? WorkLocationId { get; set; } /// - /// 部门 ID,枚举值及详细信息可通过[查询单个部门](https://open.feishu.cn/document/server-docs/corehr-v1/organization-management/department/get)接口查询获得 - /// 与 department_id_type 类型一致 + /// 部门 ID,可通过[【查询单个部门】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/department/get)获取详细信息 + /// - 与 department_id_type 类型一致 /// 必填:否 /// 示例值:6890452208593372679 /// @@ -104,7 +105,7 @@ public record JobData public string? DepartmentId { get; set; } /// - /// 岗位 ID,枚举值及详细信息可通过【查询岗位】接口查询获得 + /// 岗位 ID,功能灰度中,如有需要请联系[技术支持](https://applink.feishu.cn/TLJpeNdW) /// 必填:否 /// 示例值:6890452208593372679 /// @@ -112,7 +113,7 @@ public record JobData public string? PositionId { get; set; } /// - /// 职务 ID,枚举值及详细信息可通过[查询单个职务](https://open.feishu.cn/document/server-docs/corehr-v1/job-management/job/get)接口查询获得 + /// 职务 ID,可通过[【查询单个职务】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job/get)获取详细信息 /// 必填:否 /// 示例值:6890452208593372679 /// @@ -120,7 +121,7 @@ public record JobData public string? JobId { get; set; } /// - /// 职级 ID,枚举值及详细信息可通过[查询单个职级](https://open.feishu.cn/document/server-docs/corehr-v1/job-management/job_level/get)接口查询获得 + /// 职级 ID,可通过[【查询单个职级】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_level/get)获取详细信息 /// 必填:否 /// 示例值:6890452208593372679 /// @@ -128,8 +129,7 @@ public record JobData public string? JobLevelId { get; set; } /// - /// 职等 ID,可通过[【查询职等】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job_grade/query) - /// 获取详细信息 + /// 职等 ID,可通过[【查询职等】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job_grade/query)获取详细信息 /// 必填:否 /// 示例值:6890452208593372679 /// @@ -137,7 +137,7 @@ public record JobData public string? JobGradeId { get; set; } /// - /// 序列 ID,枚举值及详细信息可通过[查询单个序列](https://open.feishu.cn/document/server-docs/corehr-v1/job-management/job_family/get)接口查询获得 + /// 序列 ID,可通过[【查询单个序列】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_family/get)获取详细信息 /// 必填:否 /// 示例值:1245678 /// @@ -170,7 +170,7 @@ public record JobData /// /// 雇佣 ID,可通过[【批量查询员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息 - /// 与 user_id_type 类型一致 + /// - 与 user_id_type 类型一致 /// 必填:是 /// 示例值:6893014062142064135 /// @@ -209,7 +209,7 @@ public record Enum /// /// 枚举值 /// 必填:是 - /// 示例值:phone_type + /// 示例值:onboarding /// [JsonPropertyName("enum_name")] public string EnumName { get; set; } = string.Empty; @@ -282,7 +282,7 @@ public record BasicJobData /// /// 雇佣 ID,可通过[【批量查询员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息 - /// 与 user_id_type 类型一致 + /// - 与 user_id_type 类型一致 /// 必填:否 /// 示例值:6893014062142064135 /// @@ -353,7 +353,7 @@ public record JobDataCostCenter public Enum? CompensationType { get; set; } /// - /// 任职公司,枚举值及详细信息可通过[查询单个公司](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/company/get)接口查询获得 + /// 任职公司,可通过[【查询单个公司】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/company/get)获取详细信息 /// 必填:否 /// 示例值:6890452208593372680 /// diff --git a/src/Corehr/PostCorehrV2EmployeesSearchBodyDto.cs b/src/Corehr/PostCorehrV2EmployeesSearchBodyDto.cs index 6787646c..46e0c88f 100644 --- a/src/Corehr/PostCorehrV2EmployeesSearchBodyDto.cs +++ b/src/Corehr/PostCorehrV2EmployeesSearchBodyDto.cs @@ -33,6 +33,8 @@ public record PostCorehrV2EmployeesSearchBodyDto /// /// 雇佣 ID 列表 + /// - 在 [【创建雇佣】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/employment/create) + /// 返回的 ID /// - ID类型应于 user_id_type 一致 /// 必填:否 /// diff --git a/src/Corehr/PostCorehrV2EmployeesSearchResponseDto.cs b/src/Corehr/PostCorehrV2EmployeesSearchResponseDto.cs index 673dddd3..955db064 100644 --- a/src/Corehr/PostCorehrV2EmployeesSearchResponseDto.cs +++ b/src/Corehr/PostCorehrV2EmployeesSearchResponseDto.cs @@ -2185,6 +2185,8 @@ public record Education { /// /// 学校 + /// - 自定义名称时返回该字段 + /// - 下拉框选择的返回 school_name 字段 /// 必填:是 /// [JsonPropertyName("school")] @@ -2192,6 +2194,8 @@ public record Education /// /// 学校 + /// - 自定义名称时返回该字段 + /// - 下拉框选择的返回 school_name 字段 /// public record I18n { @@ -2280,6 +2284,8 @@ public record I18n /// /// 专业 + /// - 自定义名称时返回该字段 + /// - 下拉框选择的返回 field_of_study_name 字段 /// 必填:否 /// [JsonPropertyName("field_of_study")] @@ -2294,6 +2300,11 @@ public record I18n /// /// 学校名称 + /// - 可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)获取,查询参数: + /// - custom_api_name:school_name + /// - object_api_name:education + /// - 自定义名称时返回 school 字段 + /// - 下拉框选择的返回该字段 /// 必填:否 /// [JsonPropertyName("school_name")] @@ -2301,6 +2312,11 @@ public record I18n /// /// 专业名称 + /// - 可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)获取,查询参数: + /// - custom_api_name:field_of_study_name + /// - object_api_name:education + /// - 自定义名称时返回 field_of_study 字段 + /// - 下拉框选择的返回该字段 /// 必填:否 /// [JsonPropertyName("field_of_study_name")] diff --git a/src/Corehr/PostCorehrV2JobChangesSearchBodyDto.cs b/src/Corehr/PostCorehrV2JobChangesSearchBodyDto.cs index f2a22246..4765cfa6 100644 --- a/src/Corehr/PostCorehrV2JobChangesSearchBodyDto.cs +++ b/src/Corehr/PostCorehrV2JobChangesSearchBodyDto.cs @@ -4,7 +4,7 @@ // Created : 2024-06-24 // // Last Modified By : yxr -// Last Modified On : 2024-06-24 +// Last Modified On : 2024-07-18 // ************************************************************************ // // MIT @@ -22,7 +22,7 @@ namespace FeishuNetSdk.Corehr; public record PostCorehrV2JobChangesSearchBodyDto { /// - /// 雇员 ID 列表 + /// 雇员 ID 列表,可通过[【搜索员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/search)接口获取 /// 必填:否 /// 最大长度:30 /// @@ -30,7 +30,9 @@ public record PostCorehrV2JobChangesSearchBodyDto public string[]? EmploymentIds { get; set; } /// - /// 异动记录 ID 列表 + /// 异动记录 ID 列表,可通过接口 + /// [搜索异动信息 + /// ](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job_change/search)获取详细信息 /// 必填:否 /// 最大长度:10 /// @@ -47,7 +49,7 @@ public record PostCorehrV2JobChangesSearchBodyDto public string[]? Statuses { get; set; } /// - /// 异动生效日期-搜索范围开始,需要与搜索范围结束一同使用 + /// 异动生效日期 - 搜索范围开始,需要与搜索范围结束一同使用,格式:"YYYY-MM-DD" /// 必填:否 /// 示例值:2022-01-01 /// @@ -55,10 +57,26 @@ public record PostCorehrV2JobChangesSearchBodyDto public string? EffectiveDateStart { get; set; } /// - /// 异动生效日期 - 搜索范围结束 + /// 异动生效日期 - 搜索范围结束,格式:"YYYY-MM-DD" /// 必填:否 /// 示例值:2022-01-01 /// [JsonPropertyName("effective_date_end")] public string? EffectiveDateEnd { get; set; } + + /// + /// 异动更新时间 - 搜索范围开始,需要与搜索范围结束一同使用,格式:"YYYY-MM-DD" + /// 必填:否 + /// 示例值:1704084635000 + /// + [JsonPropertyName("updated_time_start")] + public string? UpdatedTimeStart { get; set; } + + /// + /// 异动更新时间 - 搜索范围结束,格式:"YYYY-MM-DD" + /// 必填:否 + /// 示例值:1704084635000 + /// + [JsonPropertyName("updated_time_end")] + public string? UpdatedTimeEnd { get; set; } } diff --git a/src/Corehr/PostCorehrV2JobChangesSearchResponseDto.cs b/src/Corehr/PostCorehrV2JobChangesSearchResponseDto.cs index d3fc6591..c9fc3a30 100644 --- a/src/Corehr/PostCorehrV2JobChangesSearchResponseDto.cs +++ b/src/Corehr/PostCorehrV2JobChangesSearchResponseDto.cs @@ -4,7 +4,7 @@ // Created : 2024-06-24 // // Last Modified By : yxr -// Last Modified On : 2024-06-24 +// Last Modified On : 2024-07-18 // ************************************************************************ // // MIT @@ -34,7 +34,9 @@ public record PostCorehrV2JobChangesSearchResponseDto public record JobChange { /// - /// 异动记录 id + /// 异动记录 id,可通过接口 + /// [搜索异动信息 + /// ](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job_change/search)获取详细信息 /// 必填:否 /// 示例值:6991776076699549697 /// @@ -42,7 +44,7 @@ public record JobChange public string? JobChangeId { get; set; } /// - /// 雇员 id + /// 雇员 id,可通过[【搜索员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/search)接口获取 /// 必填:否 /// 示例值:ou_a294793e8fa21529f2a60e3e9de45520 /// @@ -66,7 +68,9 @@ public record JobChange public string? Status { get; set; } /// - /// 异动类型 + /// 异动类型,可通过接口 + /// [获取异动类型列表 + /// ](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/transfer_type/query)获取 /// 必填:否 /// 示例值:direct_leader_change /// @@ -74,7 +78,9 @@ public record JobChange public string? TransferTypeUniqueIdentifier { get; set; } /// - /// 异动原因 + /// 异动原因,可通过接口 + /// [获取异动原因列表 + /// ](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/transfer_reason/query)获取详细信息 /// 必填:否 /// 示例值:involuntary_transfer /// @@ -82,7 +88,7 @@ public record JobChange public string? TransferReasonUniqueIdentifier { get; set; } /// - /// 异动流程 id + /// 异动流程 id,可通过【流程-获取单个流程详情】接口获取 /// 必填:否 /// 示例值:6991776078461142564 /// @@ -90,7 +96,7 @@ public record JobChange public string? ProcessId { get; set; } /// - /// 生效时间 + /// 生效时间,格式:"YYYY-MM-DD" /// 必填:否 /// 示例值:2022-03-01 /// @@ -98,7 +104,7 @@ public record JobChange public string? EffectiveDate { get; set; } /// - /// 创建时间 + /// 创建时间,毫秒级时间戳 /// 必填:否 /// 示例值:1627899724000 /// @@ -106,7 +112,7 @@ public record JobChange public string? CreatedTime { get; set; } /// - /// 更新时间 + /// 更新时间,毫秒级时间戳 /// 必填:否 /// 示例值:1647434443000 /// @@ -158,7 +164,7 @@ public record JobChangeTransferInfo public bool? ProbationExist { get; set; } /// - /// 原部门 + /// 原部门,可通过[【批量查询部门】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/department/batch_get)接口获取 /// 必填:否 /// 示例值:6966236933198579208 /// @@ -166,7 +172,7 @@ public record JobChangeTransferInfo public string? OriginalDepartment { get; set; } /// - /// 新部门 + /// 新部门,可通过[【批量查询部门】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/department/batch_get)接口获取 /// 必填:否 /// 示例值:6966236933198579208 /// @@ -174,7 +180,51 @@ public record JobChangeTransferInfo public string? TargetDepartment { get; set; } /// - /// 原工作地点 + /// 新部门(新建部门审批完成前会返回 td_xxx 的临时 ID),可通过[【批量查询部门】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/department/batch_get)接口获取 + /// 必填:否 + /// 示例值:6966236933198579208 + /// + [JsonPropertyName("target_draft_department")] + public string? TargetDraftDepartment { get; set; } + + /// + /// 原部门全路径 + /// 必填:否 + /// + [JsonPropertyName("original_department_id_path")] + public OrgdraftDepartmentId[]? OriginalDepartmentIdPaths { get; set; } + + /// + /// 原部门全路径 + /// + public record OrgdraftDepartmentId + { + /// + /// 部门 ID (新建部门审批通过前会返回空值),可通过[【批量查询部门】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/department/batch_get)接口获取 + /// 必填:否 + /// 示例值:6974659700705068581 + /// + [JsonPropertyName("department_id")] + public string? DepartmentId { get; set; } + + /// + /// 调整部门 ID ,新建部门审批通过前会返回格式为 td_xxx 的临时 ID,可通过[【批量查询部门】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/department/batch_get)接口获取 + /// 必填:否 + /// 示例值:6974659700705068581 + /// + [JsonPropertyName("draft_department_id")] + public string? DraftDepartmentId { get; set; } + } + + /// + /// 新部门全路径 + /// 必填:否 + /// + [JsonPropertyName("target_department_id_path")] + public OrgdraftDepartmentId[]? TargetDepartmentIdPaths { get; set; } + + /// + /// 原工作地点,可通过[【批量查询地点】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/location/list)接口获取 /// 必填:否 /// 示例值:6967271100992587295 /// @@ -182,7 +232,7 @@ public record JobChangeTransferInfo public string? OriginalWorkLocation { get; set; } /// - /// 新工作地点 + /// 新工作地点,可通过[【批量查询地点】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/location/list)接口获取 /// 必填:否 /// 示例值:6967271100992587295 /// @@ -190,7 +240,7 @@ public record JobChangeTransferInfo public string? TargetWorkLocation { get; set; } /// - /// 原直属上级 + /// 原直属上级,可通过[【搜索员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/search)接口获取 /// 必填:否 /// 示例值:6974641477444060708 /// @@ -198,7 +248,7 @@ public record JobChangeTransferInfo public string? OriginalDirectManager { get; set; } /// - /// 新直属上级 + /// 新直属上级,可通过[【搜索员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/search)接口获取 /// 必填:否 /// 示例值:7013619729281713671 /// @@ -206,7 +256,7 @@ public record JobChangeTransferInfo public string? TargetDirectManager { get; set; } /// - /// 原虚线上级 + /// 原虚线上级,可通过[【搜索员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/search)接口获取 /// 必填:否 /// 示例值:6974648866876573198 /// @@ -214,7 +264,7 @@ public record JobChangeTransferInfo public string? OriginalDottedManager { get; set; } /// - /// 新虚线上级 + /// 新虚线上级,可通过[【搜索员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/search)接口获取 /// 必填:否 /// 示例值:7013328578351842852 /// @@ -223,6 +273,7 @@ public record JobChangeTransferInfo /// /// 原职务 + /// 可通过[【批量查询职务】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job/list)接口获取 /// 必填:否 /// 示例值:6969469398088287751 /// @@ -231,6 +282,7 @@ public record JobChangeTransferInfo /// /// 新职务 + /// 可通过[【批量查询职务】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job/list)接口获取 /// 必填:否 /// 示例值:6969469557836760606 /// @@ -238,7 +290,7 @@ public record JobChangeTransferInfo public string? TargetJob { get; set; } /// - /// 原序列 + /// 原序列,可通过[【批量查询序列】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_family/list)接口获取 /// 必填:否 /// 示例值:6967287547462419975 /// @@ -246,7 +298,7 @@ public record JobChangeTransferInfo public string? OriginalJobFamily { get; set; } /// - /// 新序列 + /// 新序列,可通过[【批量查询序列】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_family/list)接口获取 /// 必填:否 /// 示例值:6967287547462419975 /// @@ -254,7 +306,8 @@ public record JobChangeTransferInfo public string? TargetJobFamily { get; set; } /// - /// 原级别 + /// 原职级 + /// 可通过[【批量查询职级】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_level/list)接口获取 /// 必填:否 /// 示例值:6972085707674355214 /// @@ -263,6 +316,7 @@ public record JobChangeTransferInfo /// /// 新级别 + /// 可通过[【批量查询职级】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_level/list)接口获取 /// 必填:否 /// 示例值:6972085707674355214 /// @@ -270,7 +324,7 @@ public record JobChangeTransferInfo public string? TargetJobLevel { get; set; } /// - /// 原人员类型 + /// 原人员类型,可通过[【批量查询人员类型】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/employee_type/list)接口获取 /// 必填:否 /// 示例值:6968386026792289828 /// @@ -278,7 +332,7 @@ public record JobChangeTransferInfo public string? OriginalWorkforceType { get; set; } /// - /// 新人员类型 + /// 新人员类型,可通过[【批量查询人员类型】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/employee_type/list)接口获取 /// 必填:否 /// 示例值:7036268995372303885 /// @@ -286,7 +340,7 @@ public record JobChangeTransferInfo public string? TargetWorkforceType { get; set; } /// - /// 原公司 + /// 原公司,详细信息可通过[【批量查询公司】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/company/list)接口查询获得 /// 必填:否 /// 示例值:6974659700705068581 /// @@ -294,7 +348,7 @@ public record JobChangeTransferInfo public string? OriginalCompany { get; set; } /// - /// 新公司 + /// 新公司,详细信息可通过[【批量查询公司】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/company/list)接口查询获得 /// 必填:否 /// 示例值:6974659700705068581 /// @@ -302,7 +356,7 @@ public record JobChangeTransferInfo public string? TargetCompany { get; set; } /// - /// 原合同编号 + /// 原合同编号,可通过[【批量查询合同】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/contract/list)接口获取详细信息 /// 必填:否 /// 示例值:55332 /// @@ -310,7 +364,7 @@ public record JobChangeTransferInfo public string? OriginalContractNumber { get; set; } /// - /// 新合同编号 + /// 新合同编号,可通过[【批量查询合同】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/contract/list)接口获取详细信息 /// 必填:否 /// 示例值:55333 /// @@ -318,7 +372,7 @@ public record JobChangeTransferInfo public string? TargetContractNumber { get; set; } /// - /// 原合同类型 + /// 原合同类型,可通过[【批量查询合同】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/contract/list)接口获取详细信息 /// 必填:否 /// 示例值:labor_contract /// @@ -326,7 +380,7 @@ public record JobChangeTransferInfo public string? OriginalContractType { get; set; } /// - /// 新合同类型 + /// 新合同类型,可通过[【批量查询合同】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/contract/list)接口获取详细信息 /// 必填:否 /// 示例值:labor_contract /// @@ -334,7 +388,7 @@ public record JobChangeTransferInfo public string? TargetContractType { get; set; } /// - /// 原期限类型 + /// 原期限类型,可通过[【批量查询合同】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/contract/list)接口获取详细信息 /// 必填:否 /// 示例值:fixed_term /// @@ -342,7 +396,7 @@ public record JobChangeTransferInfo public string? OriginalDurationType { get; set; } /// - /// 新期限类型 + /// 新期限类型,可通过[【批量查询合同】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/contract/list)接口获取详细信息 /// 必填:否 /// 示例值:fixed_term /// @@ -350,7 +404,7 @@ public record JobChangeTransferInfo public string? TargetDurationType { get; set; } /// - /// 原签订类型 + /// 原签订类型,可通过[【批量查询合同】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/contract/list)接口获取详细信息 /// 必填:否 /// 示例值:new /// @@ -358,7 +412,7 @@ public record JobChangeTransferInfo public string? OriginalSigningType { get; set; } /// - /// 新签订类型 + /// 新签订类型,可通过[【批量查询合同】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/contract/list)接口获取详细信息 /// 必填:否 /// 示例值:new /// @@ -366,7 +420,7 @@ public record JobChangeTransferInfo public string? TargetSigningType { get; set; } /// - /// 原合同开始日期 + /// 原合同开始日期,格式:"YYYY-MM-DD" /// 必填:否 /// 示例值:2021-07-01 /// @@ -374,7 +428,7 @@ public record JobChangeTransferInfo public string? OriginalContractStartDate { get; set; } /// - /// 新合同开始日期 + /// 新合同开始日期,格式:"YYYY-MM-DD" /// 必填:否 /// 示例值:2021-07-01 /// @@ -382,7 +436,7 @@ public record JobChangeTransferInfo public string? TargetContractStartDate { get; set; } /// - /// 原合同结束日期 + /// 原合同结束日期,格式:"YYYY-MM-DD" /// 必填:否 /// 示例值:2024-07-01 /// @@ -390,7 +444,7 @@ public record JobChangeTransferInfo public string? OriginalContractEndDate { get; set; } /// - /// 新合同结束日期 + /// 新合同结束日期,格式:"YYYY-MM-DD" /// 必填:否 /// 示例值:2024-07-01 /// @@ -398,7 +452,7 @@ public record JobChangeTransferInfo public string? TargetContractEndDate { get; set; } /// - /// 原工时制度 + /// 原工时制度可通过[【批量查询工时制度】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/working_hours_type/list)接口获取 /// 必填:否 /// 示例值:6969087376740206087 /// @@ -406,7 +460,7 @@ public record JobChangeTransferInfo public string? OriginalWorkingHoursType { get; set; } /// - /// 新工时制度 + /// 新工时制度,可通过[【批量查询工时制度】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/working_hours_type/list)接口获取 /// 必填:否 /// 示例值:6969087376740206087 /// @@ -414,7 +468,7 @@ public record JobChangeTransferInfo public string? TargetWorkingHoursType { get; set; } /// - /// 原工作日历 + /// 原工作日历,开通休假服务后联系管理员获取。 /// 必填:否 /// 示例值:6969087376740236087 /// @@ -422,7 +476,7 @@ public record JobChangeTransferInfo public string? OriginalWorkingCalendar { get; set; } /// - /// 新工作日历 + /// 新工作日历,开通休假服务后联系管理员获取。 /// 必填:否 /// 示例值:6969087376740236087 /// @@ -430,7 +484,7 @@ public record JobChangeTransferInfo public string? TargetWorkingCalendar { get; set; } /// - /// 原试用期预计结束日期 + /// 原试用期预计结束日期,格式:"YYYY-MM-DD" /// 必填:否 /// 示例值:2021-11-17 /// @@ -438,7 +492,7 @@ public record JobChangeTransferInfo public string? OriginalProbationEndDate { get; set; } /// - /// 新试用期预计结束日期 + /// 新试用期预计结束日期,格式:"YYYY-MM-DD" /// 必填:否 /// 示例值:2021-11-17 /// @@ -490,7 +544,7 @@ public record JobChangeTransferInfo public record JobDataCostCenter { /// - /// 成本中心 ID,可以通过【查询单个成本中心信息】接口获取对应的成本中心信息 + /// 成本中心 ID,详细信息可通过[【搜索成本中心信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/cost_center/search)接口查询获得 /// 必填:否 /// 示例值:6950635856373745165 /// @@ -526,7 +580,7 @@ public record JobDataCostCenter public record TranferEmploymentInfo { /// - /// 转正式员工日期 + /// 转正式员工日期,格式:"YYYY-MM-DD" /// 必填:否 /// 示例值:2023-01-01 /// @@ -534,7 +588,7 @@ public record TranferEmploymentInfo public string? RegularEmployeeStartDate { get; set; } /// - /// 司龄起算日期 + /// 司龄起算日期,格式:"YYYY-MM-DD" /// 必填:否 /// 示例值:2023-01-01 /// @@ -542,7 +596,7 @@ public record TranferEmploymentInfo public string? SeniorityDate { get; set; } /// - /// 员工编号 + /// 员工编号,可通过[【搜索员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/search)接口获取 /// 必填:否 /// 示例值:1111111 /// @@ -609,7 +663,7 @@ public record CustomName /// /// 字段值,是 json 转义后的字符串,根据元数据定义不同,字段格式不同(如 123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05") /// 必填:是 - /// 示例值:\"231\" + /// 示例值:231 /// [JsonPropertyName("value")] public string Value { get; set; } = string.Empty; @@ -624,7 +678,7 @@ public record CustomName public TranferEmploymentInfo? TargetEmploymentChange { get; set; } /// - /// 原职等 + /// 原职等,可通过[【查询职等】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job_grade/query)接口获取 /// 必填:否 /// 示例值:7289005963599693366 /// @@ -632,12 +686,60 @@ public record CustomName public string? OriginalJobGrade { get; set; } /// - /// 新职等 + /// 新职等,可通过[【查询职等】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job_grade/query)接口获取 /// 必填:否 /// 示例值:7289005963599693366 /// [JsonPropertyName("target_job_grade")] public string? TargetJobGrade { get; set; } + + /// + /// 原薪资类型 + /// 必填:否 + /// 示例值:hourly + /// + [JsonPropertyName("original_compensation_type")] + public string? OriginalCompensationType { get; set; } + + /// + /// 新薪资类型 + /// 必填:否 + /// 示例值:salary + /// + [JsonPropertyName("target_compensation_type")] + public string? TargetCompensationType { get; set; } + + /// + /// 原任职公司,详细信息可通过[【批量查询公司】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/company/list)接口查询获得 + /// 必填:否 + /// 示例值:7289005963599693367 + /// + [JsonPropertyName("original_service_company")] + public string? OriginalServiceCompany { get; set; } + + /// + /// 新任职公司,详细信息可通过[【批量查询公司】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/company/list)接口查询获得 + /// 必填:否 + /// 示例值:7289005963599693367 + /// + [JsonPropertyName("target_service_company")] + public string? TargetServiceCompany { get; set; } + + /// + /// 原岗位,可通过【岗职务管理-岗位】相关API获取(目前仅灰度部分租户,如需要请联系管理员开灰) + /// 必填:否 + /// 示例值:7289005963599693367 + /// + [JsonPropertyName("original_position")] + public string? OriginalPosition { get; set; } + + /// + /// 新岗位,可通过【岗职务管理-岗位】相关API获取(目前仅灰度部分租户,如需要请联系管理员开灰) + /// 必填:否 + /// 示例值:7289005963599693367 + /// + [JsonPropertyName("target_position")] + public string? TargetPosition { get; set; } } } diff --git a/src/Corehr/PostCorehrV2PreHiresBodyDto.cs b/src/Corehr/PostCorehrV2PreHiresBodyDto.cs index c2d84fdb..e183ea6a 100644 --- a/src/Corehr/PostCorehrV2PreHiresBodyDto.cs +++ b/src/Corehr/PostCorehrV2PreHiresBodyDto.cs @@ -177,9 +177,9 @@ public record PostCorehrV2PreHiresBodyDtoBasicInfoName public string? PersonalIdType { get; set; } /// - /// 参加工作日期 + /// 参加工作日期,格式:"YYYY-MM-DD" /// 必填:否 - /// 示例值:2100-09-09 + /// 示例值:2010-09-09 /// [JsonPropertyName("date_entered_workforce")] public string? DateEnteredWorkforce { get; set; } @@ -235,7 +235,8 @@ public record PostCorehrV2PreHiresBodyDtoBasicInfoName public string? WorkerId { get; set; } /// - /// 数据驻留地,枚举值可查询[获取字段详情](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口获取,按如下参数查询即可: + /// 数据驻留地(部分租户开通此功能),枚举值可查询[获取字段详情](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口获取。 + /// 按如下参数查询即可: /// - object_api_name = pre_hire /// - custom_api_name = user_geo /// 必填:否 @@ -645,7 +646,7 @@ public record NationalIdForUpdate public string NationalIdNumber { get; set; } = string.Empty; /// - /// 证件签发日期 + /// 证件签发日期,格式:"YYYY-MM-DD" /// 必填:否 /// 示例值:2020-04-01 /// @@ -653,7 +654,7 @@ public record NationalIdForUpdate public string? IssueDate { get; set; } /// - /// 证件到期日期 + /// 证件到期日期,格式:"YYYY-MM-DD" /// 必填:否 /// 示例值:2020-05-21 /// @@ -712,7 +713,7 @@ public record NationalIdForUpdate public string? Employer { get; set; } /// - /// 岗位 + /// 岗位信息 /// 必填:否 /// 示例值:保安 /// @@ -1630,7 +1631,7 @@ public record PostCorehrV2PreHiresBodyDtoOfferInfo public string? OfferId { get; set; } /// - /// Offer HR ID,可以通过[批量查询员工信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)接口获取 + /// Offer HR 雇佣 ID,可以通过[批量查询员工信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)接口获取 /// 必填:否 /// 示例值:7032210902531327521 /// @@ -1686,7 +1687,7 @@ public record PostCorehrV2PreHiresBodyDtoOfferInfo public string? JobTitle { get; set; } /// - /// 试用期开始日期 + /// 试用期开始日期,格式:"YYYY-MM-DD" /// 必填:否 /// 示例值:2022-07-29 /// @@ -1694,7 +1695,7 @@ public record PostCorehrV2PreHiresBodyDtoOfferInfo public string? ProbationStartDate { get; set; } /// - /// 试用期结束日期 + /// 试用期结束日期,格式:"YYYY-MM-DD" /// 必填:否 /// 示例值:2023-04-07 /// @@ -1702,7 +1703,7 @@ public record PostCorehrV2PreHiresBodyDtoOfferInfo public string? ProbationEndDate { get; set; } /// - /// 合同开始日期 + /// 合同开始日期,格式:"YYYY-MM-DD" /// 必填:否 /// 示例值:2022-10-08 /// @@ -1710,7 +1711,7 @@ public record PostCorehrV2PreHiresBodyDtoOfferInfo public string? ContractStartDate { get; set; } /// - /// 合同结束日期 + /// 合同结束日期,格式:"YYYY-MM-DD" /// 必填:否 /// 示例值:2025-10-07 /// @@ -1736,7 +1737,7 @@ public record PostCorehrV2PreHiresBodyDtoOfferInfo public string? DurationUnit { get; set; } /// - /// 入职日期 + /// 入职日期,格式:"YYYY-MM-DD" /// 必填:否 /// 示例值:2022-10-08 /// @@ -2018,7 +2019,7 @@ public record ObjectFieldData public string? FlowId { get; set; } /// - /// 签到日期 + /// 签到日期,格式:"YYYY-MM-DD" /// 必填:否 /// 示例值:2024-12-31 /// @@ -2067,7 +2068,7 @@ public record EducationInfo public string? Education { get; set; } /// - /// 开始时间 + /// 开始时间,格式:"YYYY-MM-DD" /// 必填:否 /// 示例值:2017-04-01 /// @@ -2075,7 +2076,7 @@ public record EducationInfo public string? StartTime { get; set; } /// - /// 结束时间 + /// 结束时间,格式:"YYYY-MM-DD" /// 必填:否 /// 示例值:2018-04-01 /// @@ -2112,7 +2113,7 @@ public record WorkExperience public string? CompanyName { get; set; } /// - /// 开始时间 + /// 开始时间,格式:"YYYY-MM-DD" /// 必填:否 /// 示例值:2015-02-01 /// @@ -2120,7 +2121,7 @@ public record WorkExperience public string? StartTime { get; set; } /// - /// 结束时间 + /// 结束时间,格式:"YYYY-MM-DD" /// 必填:否 /// 示例值:2017-02-01 /// diff --git a/src/Corehr/PostCorehrV2PreHiresByPreHireIdCompleteResponseDto.cs b/src/Corehr/PostCorehrV2PreHiresByPreHireIdCompleteResponseDto.cs new file mode 100644 index 00000000..2f56c2bb --- /dev/null +++ b/src/Corehr/PostCorehrV2PreHiresByPreHireIdCompleteResponseDto.cs @@ -0,0 +1,31 @@ +// ************************************************************************ +// Assembly : FeishuNetSdk +// Author : yxr +// Created : 2024-07-18 +// +// Last Modified By : yxr +// Last Modified On : 2024-07-18 +// ************************************************************************ +// +// MIT +// +// 操作员工完成入职 响应体 +// ************************************************************************ +namespace FeishuNetSdk.Corehr; +/// +/// 操作员工完成入职 响应体 +/// 操作待入职员工完成入职,正式入职建立员工和公司/组织的雇佣关系 +/// 接口ID:7357756972752699394 +/// 文档地址:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/pre_hire/complete +/// JSON地址:https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2fcorehr-v2%2fpre_hire%2fcomplete +/// +public record PostCorehrV2PreHiresByPreHireIdCompleteResponseDto +{ + /// + /// 是否成功完成入职 + /// 必填:否 + /// 示例值:true + /// + [JsonPropertyName("success")] + public bool? Success { get; set; } +} diff --git a/src/Corehr/PostCorehrV2PreHiresByPreHireIdTransitTaskBodyDto.cs b/src/Corehr/PostCorehrV2PreHiresByPreHireIdTransitTaskBodyDto.cs new file mode 100644 index 00000000..20741da1 --- /dev/null +++ b/src/Corehr/PostCorehrV2PreHiresByPreHireIdTransitTaskBodyDto.cs @@ -0,0 +1,31 @@ +// ************************************************************************ +// Assembly : FeishuNetSdk +// Author : yxr +// Created : 2024-07-18 +// +// Last Modified By : yxr +// Last Modified On : 2024-07-18 +// ************************************************************************ +// +// MIT +// +// 流转入职任务 请求体 +// ************************************************************************ +namespace FeishuNetSdk.Corehr; +/// +/// 流转入职任务 请求体 +/// 配置入职流程后,可通过本接口流转进行中的任务 +/// 接口ID:7357756972752732162 +/// 文档地址:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/pre_hire/transit_task +/// JSON地址:https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2fcorehr-v2%2fpre_hire%2ftransit_task +/// +public record PostCorehrV2PreHiresByPreHireIdTransitTaskBodyDto +{ + /// + /// 系统预置的职位信息和个人信息任务的task_id分别为1和2,自定义任务的task_id是一串UUID + /// 必填:是 + /// 示例值:1 + /// + [JsonPropertyName("task_id")] + public string TaskId { get; set; } = string.Empty; +} diff --git a/src/Corehr/PostCorehrV2PreHiresByPreHireIdTransitTaskResponseDto.cs b/src/Corehr/PostCorehrV2PreHiresByPreHireIdTransitTaskResponseDto.cs new file mode 100644 index 00000000..c2af042d --- /dev/null +++ b/src/Corehr/PostCorehrV2PreHiresByPreHireIdTransitTaskResponseDto.cs @@ -0,0 +1,31 @@ +// ************************************************************************ +// Assembly : FeishuNetSdk +// Author : yxr +// Created : 2024-07-18 +// +// Last Modified By : yxr +// Last Modified On : 2024-07-18 +// ************************************************************************ +// +// MIT +// +// 流转入职任务 响应体 +// ************************************************************************ +namespace FeishuNetSdk.Corehr; +/// +/// 流转入职任务 响应体 +/// 配置入职流程后,可通过本接口流转进行中的任务 +/// 接口ID:7357756972752732162 +/// 文档地址:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/pre_hire/transit_task +/// JSON地址:https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2fcorehr-v2%2fpre_hire%2ftransit_task +/// +public record PostCorehrV2PreHiresByPreHireIdTransitTaskResponseDto +{ + /// + /// 是否成功流转任务 + /// 必填:否 + /// 示例值:true + /// + [JsonPropertyName("success")] + public bool? Success { get; set; } +} diff --git a/src/Corehr/PostCorehrV2PreHiresQueryBodyDto.cs b/src/Corehr/PostCorehrV2PreHiresQueryBodyDto.cs new file mode 100644 index 00000000..4a0bf05c --- /dev/null +++ b/src/Corehr/PostCorehrV2PreHiresQueryBodyDto.cs @@ -0,0 +1,53 @@ +// ************************************************************************ +// Assembly : FeishuNetSdk +// Author : yxr +// Created : 2024-07-18 +// +// Last Modified By : yxr +// Last Modified On : 2024-07-18 +// ************************************************************************ +// +// MIT +// +// 查询待入职信息 请求体 +// ************************************************************************ +namespace FeishuNetSdk.Corehr; +/// +/// 查询待入职信息 请求体 +/// 该接口用于根据待入职人员 ID(支持批量)查询待入职人员信息,信息包含姓名、手机号等个人信息和任职信息。 +/// - 延迟说明:数据库主从延迟 2s 以内,即:直接创建待入职后2s内调用此接口可能查询不到数据。 +/// - 性能说明:本接口返回数据量较多,查询时请控制每批次数量(<10)和适当减少查询字段数(<50) +/// 接口ID:7386487948991299587 +/// 文档地址:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/pre_hire/query +/// JSON地址:https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2fcorehr-v2%2fpre_hire%2fquery +/// +public record PostCorehrV2PreHiresQueryBodyDto +{ + /// + /// 待入职人员 ID 列表 + /// 必填:否 + /// 最大长度:10 + /// 最小长度:0 + /// + [JsonPropertyName("pre_hire_ids")] + public string[]? PreHireIds { get; set; } + + /// + /// 返回数据的字段列表,填写方式: + /// - 为空时只返回 pre_hire_id + /// - 不为空时按照传入的字段返回数据,数据结构可以参考response的数据结构,格式示例如下: + /// - person_info(个人信息) 字段:person_info.gender,person_info.age + /// - employment_info(雇佣信息) 字段:employment_info.department + /// - onboarding_info(入职信息) 字段:onboarding_info.onboarding_date + /// - probation_info(试用期信息) 字段:probation_info.probation_period + /// - contract_info(合同信息) 字段:contract_info.contract_type + /// - 如果要返回所有下级,只用传上级结构体名称,例如 person_info + /// - 返回数据越多,查询接口性能越慢,请按需填写返回字段 + /// 必填:否 + /// 示例值:\["person_info","employment_info.department","probation_info.probation_period"\] + /// 最大长度:100 + /// 最小长度:0 + /// + [JsonPropertyName("fields")] + public string[]? Fields { get; set; } +} diff --git a/src/Corehr/PostCorehrV2PreHiresQueryResponseDto.cs b/src/Corehr/PostCorehrV2PreHiresQueryResponseDto.cs new file mode 100644 index 00000000..9abe9a55 --- /dev/null +++ b/src/Corehr/PostCorehrV2PreHiresQueryResponseDto.cs @@ -0,0 +1,5482 @@ +// ************************************************************************ +// Assembly : FeishuNetSdk +// Author : yxr +// Created : 2024-07-18 +// +// Last Modified By : yxr +// Last Modified On : 2024-07-18 +// ************************************************************************ +// +// MIT +// +// 查询待入职信息 响应体 +// ************************************************************************ +namespace FeishuNetSdk.Corehr; +/// +/// 查询待入职信息 响应体 +/// 该接口用于根据待入职人员 ID(支持批量)查询待入职人员信息,信息包含姓名、手机号等个人信息和任职信息。 +/// - 延迟说明:数据库主从延迟 2s 以内,即:直接创建待入职后2s内调用此接口可能查询不到数据。 +/// - 性能说明:本接口返回数据量较多,查询时请控制每批次数量(<10)和适当减少查询字段数(<50) +/// 接口ID:7386487948991299587 +/// 文档地址:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/pre_hire/query +/// JSON地址:https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2fcorehr-v2%2fpre_hire%2fquery +/// +public record PostCorehrV2PreHiresQueryResponseDto +{ + /// + /// 查询待入职的信息 + /// 必填:否 + /// + [JsonPropertyName("items")] + public PreHire[]? Items { get; set; } + + /// + /// 查询待入职的信息 + /// + public record PreHire + { + /// + /// 个人信息 + /// 必填:否 + /// + [JsonPropertyName("person_info")] + public PreHirePersonInfo? PersonInfo { get; set; } + + /// + /// 个人信息 + /// + public record PreHirePersonInfo + { + /// + /// 个人信息 ID + /// 必填:否 + /// 示例值:6919733936050406926 + /// + [JsonPropertyName("person_id")] + public string? PersonId { get; set; } + + /// + /// 个人电话 + /// 必填:否 + /// 示例值:13649211111 + /// + [JsonPropertyName("phone_number")] + public string? PhoneNumber { get; set; } + + /// + /// 法定姓名 + /// 必填:否 + /// 示例值:张三 + /// + [JsonPropertyName("legal_name")] + public string? LegalName { get; set; } + + /// + /// 常用名 + /// 必填:否 + /// 示例值:刘梓新(Henry) + /// + [JsonPropertyName("preferred_name")] + public string? PreferredName { get; set; } + + /// + /// 常用本地全名 + /// 必填:否 + /// 示例值:刘梓新 + /// + [JsonPropertyName("preferred_local_full_name")] + public string? PreferredLocalFullName { get; set; } + + /// + /// 常用英文全名 + /// 必填:否 + /// 示例值:Henry + /// + [JsonPropertyName("preferred_english_full_name")] + public string? PreferredEnglishFullName { get; set; } + + /// + /// 姓名列表 + /// 必填:否 + /// + [JsonPropertyName("name_list")] + public PersonName[]? NameLists { get; set; } + + /// + /// 姓名列表 + /// + public record PersonName + { + /// + /// 姓 - 本地文字 + /// 必填:否 + /// 示例值:黄 + /// + [JsonPropertyName("local_primary")] + public string? LocalPrimary { get; set; } + + /// + /// 名 - 本地文字 + /// 必填:否 + /// 示例值:四 + /// + [JsonPropertyName("local_first_name")] + public string? LocalFirstName { get; set; } + + /// + /// 国家 / 地区,可以通过接口[查询国家/地区信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region/search)获取详情 + /// 必填:是 + /// 示例值:6862995757234914824 + /// + [JsonPropertyName("country_region_id")] + public string CountryRegionId { get; set; } = string.Empty; + + /// + /// 姓名类型,枚举值可通过文档[枚举常量介绍](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/feishu-people-enum-constant)姓名类型(name_type)枚举定义获得 + /// 必填:是 + /// + [JsonPropertyName("name_type")] + public Enum NameType { get; set; } = new(); + + /// + /// 姓名类型,枚举值可通过文档[枚举常量介绍](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/feishu-people-enum-constant)姓名类型(name_type)枚举定义获得 + /// + public record Enum + { + /// + /// 枚举值 + /// 必填:是 + /// 示例值:phone_type + /// + [JsonPropertyName("enum_name")] + public string EnumName { get; set; } = string.Empty; + + /// + /// 枚举多语展示 + /// 必填:否 + /// + [JsonPropertyName("display")] + public I18n[]? Displies { get; set; } + + /// + /// 枚举多语展示 + /// + public record I18n + { + /// + /// 语言编码(IETF BCP 47) + /// 必填:是 + /// 示例值:zh-CN + /// + [JsonPropertyName("lang")] + public string Lang { get; set; } = string.Empty; + + /// + /// 文本内容 + /// 必填:是 + /// 示例值:中文示例 + /// + [JsonPropertyName("value")] + public string Value { get; set; } = string.Empty; + } + } + + /// + /// 名 - 第二本地文字 + /// 必填:否 + /// 示例值:五 + /// + [JsonPropertyName("local_first_name_2")] + public string? LocalFirstName2 { get; set; } + + /// + /// 姓 - 第二本地文字 + /// 必填:否 + /// 示例值:王 + /// + [JsonPropertyName("local_primary_2")] + public string? LocalPrimary2 { get; set; } + + /// + /// 补充姓名类型,枚举值可查询[获取字段详情](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口获取,按如下参数查询即可: + /// - custom_api_name:additional_name_type + /// - object_api_name:person_name + /// 必填:否 + /// + [JsonPropertyName("additional_name_type")] + public Enum? AdditionalNameType { get; set; } + + /// + /// + /// 必填:否 + /// 示例值:帅 + /// + [JsonPropertyName("first_name")] + public string? FirstName { get; set; } + + /// + /// 全名 + /// 必填:否 + /// 示例值:王大帅 + /// + [JsonPropertyName("full_name")] + public string? FullName { get; set; } + + /// + /// 姓氏称谓 + /// 必填:否 + /// 示例值:王 + /// + [JsonPropertyName("hereditary")] + public string? Hereditary { get; set; } + + /// + /// 自定义姓名(未传入时,姓名将默认根据所属国家 / 地区规则对相关姓、名字段拼接) + /// 必填:否 + /// 示例值:王大帅 + /// + [JsonPropertyName("custom_name")] + public string? CustomName { get; set; } + + /// + /// 本地文字的自定义姓名(未传入时,本地文字的姓名将默认根据所属国家 / 地区规则对本地文字的相关姓、名字段拼接) + /// 必填:否 + /// 示例值:王大帅 + /// + [JsonPropertyName("custom_local_name")] + public string? CustomLocalName { get; set; } + + /// + /// 中间名 + /// 必填:否 + /// 示例值:大 + /// + [JsonPropertyName("middle_name")] + public string? MiddleName { get; set; } + + /// + /// + /// 必填:否 + /// 示例值:王 + /// + [JsonPropertyName("name_primary")] + public string? NamePrimary { get; set; } + + /// + /// 第二姓氏 + /// 必填:否 + /// 示例值:王 + /// + [JsonPropertyName("secondary")] + public string? Secondary { get; set; } + + /// + /// 尊称,枚举值可查询[获取字段详情](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口获取,按如下参数查询即可: + /// - custom_api_name:social + /// - object_api_name:person_name + /// 必填:否 + /// 示例值:王大帅 + /// + [JsonPropertyName("social")] + public Enum? Social { get; set; } + + /// + /// 婚后姓氏 + /// 必填:否 + /// 示例值:王 + /// + [JsonPropertyName("tertiary")] + public string? Tertiary { get; set; } + + /// + /// 头衔,枚举值可查询[获取字段详情](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口获取,按如下参数查询即可: + /// - custom_api_name:title + /// - object_api_name:person_name + /// 必填:否 + /// 示例值:王 + /// + [JsonPropertyName("title")] + public Enum? Title { get; set; } + + /// + /// 本地中间名 + /// 必填:否 + /// 示例值:大 + /// + [JsonPropertyName("local_middle_name")] + public string? LocalMiddleName { get; set; } + + /// + /// 第二姓氏 - 本地文字 + /// 必填:否 + /// 示例值:王 + /// + [JsonPropertyName("local_secondary")] + public string? LocalSecondary { get; set; } + + /// + /// 展示姓名(本地和西方文字) + /// 必填:否 + /// 示例值:王大帅 + /// + [JsonPropertyName("display_name_local_and_western_script")] + public string? DisplayNameLocalAndWesternScript { get; set; } + + /// + /// 展示姓名(本地文字) + /// 必填:否 + /// 示例值:王大帅 + /// + [JsonPropertyName("display_name_local_script")] + public string? DisplayNameLocalScript { get; set; } + + /// + /// 展示姓名(西方文字) + /// 必填:否 + /// 示例值:王大帅 + /// + [JsonPropertyName("display_name_western_script")] + public string? DisplayNameWesternScript { get; set; } + } + + /// + /// 性别,枚举值可通过文档[枚举常量介绍](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/feishu-people-enum-constant)性别(gendar)枚举定义获得 + /// 必填:否 + /// + [JsonPropertyName("gender")] + public Enum? Gender { get; set; } + + /// + /// 性别,枚举值可通过文档[枚举常量介绍](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/feishu-people-enum-constant)性别(gendar)枚举定义获得 + /// + public record Enum + { + /// + /// 枚举值 + /// 必填:是 + /// 示例值:phone_type + /// + [JsonPropertyName("enum_name")] + public string EnumName { get; set; } = string.Empty; + + /// + /// 枚举多语展示 + /// 必填:否 + /// + [JsonPropertyName("display")] + public I18n[]? Displies { get; set; } + + /// + /// 枚举多语展示 + /// + public record I18n + { + /// + /// 语言编码(IETF BCP 47) + /// 必填:是 + /// 示例值:zh-CN + /// + [JsonPropertyName("lang")] + public string Lang { get; set; } = string.Empty; + + /// + /// 文本内容 + /// 必填:是 + /// 示例值:中文示例 + /// + [JsonPropertyName("value")] + public string Value { get; set; } = string.Empty; + } + } + + /// + /// 出生日期 + /// 必填:否 + /// 示例值:2020-01-01 + /// + [JsonPropertyName("date_of_birth")] + public string? DateOfBirth { get; set; } + + /// + /// 民族,枚举值可通过文档[枚举常量介绍](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/feishu-people-enum-constant)民族(race)枚举定义获得 + /// 必填:否 + /// + [JsonPropertyName("race")] + public Enum? Race { get; set; } + + /// + /// 婚姻状况,枚举值可通过文档[枚举常量介绍](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/feishu-people-enum-constant)婚姻状况(marital_status)枚举定义获得 + /// 必填:否 + /// + [JsonPropertyName("marital_status")] + public Enum? MaritalStatus { get; set; } + + /// + /// 电话列表,只有当满足下面所有条件时,电话在个人信息页才可见 + /// 必填:否 + /// + [JsonPropertyName("phone_list")] + public Phone[]? PhoneLists { get; set; } + + /// + /// 电话列表,只有当满足下面所有条件时,电话在个人信息页才可见 + /// + public record Phone + { + /// + /// 国家区号,枚举值可通过文档[枚举常量介绍](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/feishu-people-enum-constant)手机区号(international_area_code)枚举定义获得 + /// 必填:否 + /// + [JsonPropertyName("international_area_code")] + public Enum? InternationalAreaCode { get; set; } + + /// + /// 国家区号,枚举值可通过文档[枚举常量介绍](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/feishu-people-enum-constant)手机区号(international_area_code)枚举定义获得 + /// + public record Enum + { + /// + /// 枚举值 + /// 必填:是 + /// 示例值:phone_type + /// + [JsonPropertyName("enum_name")] + public string EnumName { get; set; } = string.Empty; + + /// + /// 枚举多语展示 + /// 必填:否 + /// + [JsonPropertyName("display")] + public I18n[]? Displies { get; set; } + + /// + /// 枚举多语展示 + /// + public record I18n + { + /// + /// 语言编码(IETF BCP 47) + /// 必填:是 + /// 示例值:zh-CN + /// + [JsonPropertyName("lang")] + public string Lang { get; set; } = string.Empty; + + /// + /// 文本内容 + /// 必填:是 + /// 示例值:中文示例 + /// + [JsonPropertyName("value")] + public string Value { get; set; } = string.Empty; + } + } + + /// + /// 电话号码 + /// 必填:是 + /// 示例值:010-12345678 + /// + [JsonPropertyName("phone_number")] + public string PhoneNumber { get; set; } = string.Empty; + + /// + /// 完整电话号码 + /// 必填:否 + /// 示例值:+86 010-12345678 + /// + [JsonPropertyName("formatted_phone_number")] + public string? FormattedPhoneNumber { get; set; } + + /// + /// 设备类型,枚举值可通过文档[枚举常量介绍](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/feishu-people-enum-constant)设备类型(device_type)枚举定义获得 + /// 必填:否 + /// + [JsonPropertyName("device_type")] + public Enum? DeviceType { get; set; } + + /// + /// 电话用途,枚举值可通过文档[枚举常量介绍](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/feishu-people-enum-constant)电话用途(phone_usage)枚举定义获得 + /// 必填:否 + /// + [JsonPropertyName("phone_usage")] + public Enum? PhoneUsage { get; set; } + + /// + /// 主要电话 + /// 必填:否 + /// 示例值:true + /// + [JsonPropertyName("is_primary")] + public bool? IsPrimary { get; set; } + + /// + /// 公开电话 + /// 必填:否 + /// 示例值:true + /// + [JsonPropertyName("is_public")] + public bool? IsPublic { get; set; } + } + + /// + /// 地址列表 + /// 必填:否 + /// + [JsonPropertyName("address_list")] + public Address[]? AddressLists { get; set; } + + /// + /// 地址列表 + /// + public record Address + { + /// + /// 完整地址(本地文字) + /// 必填:否 + /// 示例值:中国北京北京 + /// + [JsonPropertyName("full_address_local_script")] + public string? FullAddressLocalScript { get; set; } + + /// + /// 完整地址(西方文字) + /// 必填:否 + /// 示例值:Beijing, Beijing, China, + /// + [JsonPropertyName("full_address_western_script")] + public string? FullAddressWesternScript { get; set; } + + /// + /// 地址 ID + /// 必填:否 + /// 示例值:6989822217869624863 + /// + [JsonPropertyName("address_id")] + public string? AddressId { get; set; } + + /// + /// 国家 / 地区,可以通过接口[查询国家/地区信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region/search)获取详情 + /// 必填:是 + /// 示例值:6862995757234914824 + /// + [JsonPropertyName("country_region_id")] + public string CountryRegionId { get; set; } = string.Empty; + + /// + /// 主要行政区ID 可以通过[查询省份/行政区信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region_subdivision/search)接口获取详情 + /// 必填:否 + /// 示例值:6863326815667095047 + /// + [JsonPropertyName("region_id")] + public string? RegionId { get; set; } + + /// + /// 地址行 1 + /// 必填:否 + /// 示例值:丹佛测试地址-纽埃时区 + /// + [JsonPropertyName("address_line1")] + public string? AddressLine1 { get; set; } + + /// + /// 地址行 2 + /// 必填:否 + /// 示例值:PoewH + /// + [JsonPropertyName("address_line2")] + public string? AddressLine2 { get; set; } + + /// + /// 地址行 3 + /// 必填:否 + /// 示例值:PoewH + /// + [JsonPropertyName("address_line3")] + public string? AddressLine3 { get; set; } + + /// + /// 地址行 4 + /// 必填:否 + /// 示例值:jmwJc + /// + [JsonPropertyName("address_line4")] + public string? AddressLine4 { get; set; } + + /// + /// 地址行 5 + /// 必填:否 + /// 示例值:jmwJc + /// + [JsonPropertyName("address_line5")] + public string? AddressLine5 { get; set; } + + /// + /// 地址行 6 + /// 必填:否 + /// 示例值:jmwJc + /// + [JsonPropertyName("address_line6")] + public string? AddressLine6 { get; set; } + + /// + /// 地址行 7 + /// 必填:否 + /// 示例值:jmwJc + /// + [JsonPropertyName("address_line7")] + public string? AddressLine7 { get; set; } + + /// + /// 地址行 8 + /// 必填:否 + /// 示例值:rafSu + /// + [JsonPropertyName("address_line8")] + public string? AddressLine8 { get; set; } + + /// + /// 地址行 9 + /// 必填:否 + /// 示例值:McPRG + /// + [JsonPropertyName("address_line9")] + public string? AddressLine9 { get; set; } + + /// + /// 地址行 1(非拉丁语系的本地文字) + /// 必填:否 + /// 示例值:丹佛测试地址-纽埃时区 + /// + [JsonPropertyName("local_address_line1")] + public string? LocalAddressLine1 { get; set; } + + /// + /// 地址行 2(非拉丁语系的本地文字) + /// 必填:否 + /// 示例值:PoewH + /// + [JsonPropertyName("local_address_line2")] + public string? LocalAddressLine2 { get; set; } + + /// + /// 地址行 3(非拉丁语系的本地文字) + /// 必填:否 + /// 示例值:PoewH + /// + [JsonPropertyName("local_address_line3")] + public string? LocalAddressLine3 { get; set; } + + /// + /// 地址行 4(非拉丁语系的本地文字) + /// 必填:否 + /// 示例值:jmwJc + /// + [JsonPropertyName("local_address_line4")] + public string? LocalAddressLine4 { get; set; } + + /// + /// 地址行 5(非拉丁语系的本地文字) + /// 必填:否 + /// 示例值:jmwJc + /// + [JsonPropertyName("local_address_line5")] + public string? LocalAddressLine5 { get; set; } + + /// + /// 地址行 6(非拉丁语系的本地文字) + /// 必填:否 + /// 示例值:jmwJc + /// + [JsonPropertyName("local_address_line6")] + public string? LocalAddressLine6 { get; set; } + + /// + /// 地址行 7(非拉丁语系的本地文字) + /// 必填:否 + /// 示例值:jmwJc + /// + [JsonPropertyName("local_address_line7")] + public string? LocalAddressLine7 { get; set; } + + /// + /// 地址行 8(非拉丁语系的本地文字) + /// 必填:否 + /// 示例值:rafSu + /// + [JsonPropertyName("local_address_line8")] + public string? LocalAddressLine8 { get; set; } + + /// + /// 地址行 9(非拉丁语系的本地文字) + /// 必填:否 + /// 示例值:McPRG + /// + [JsonPropertyName("local_address_line9")] + public string? LocalAddressLine9 { get; set; } + + /// + /// 邮政编码 + /// 必填:否 + /// 示例值:611530 + /// + [JsonPropertyName("postal_code")] + public string? PostalCode { get; set; } + + /// + /// 地址类型,枚举值可通过文档[枚举常量介绍](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/feishu-people-enum-constant)地址类型(address_type)枚举定义获得 + /// 必填:是 + /// + [JsonPropertyName("address_type_list")] + public Enum[] AddressTypeLists { get; set; } = Array.Empty(); + + /// + /// 地址类型,枚举值可通过文档[枚举常量介绍](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/feishu-people-enum-constant)地址类型(address_type)枚举定义获得 + /// + public record Enum + { + /// + /// 枚举值 + /// 必填:是 + /// 示例值:phone_type + /// + [JsonPropertyName("enum_name")] + public string EnumName { get; set; } = string.Empty; + + /// + /// 枚举多语展示 + /// 必填:否 + /// + [JsonPropertyName("display")] + public I18n[]? Displies { get; set; } + + /// + /// 枚举多语展示 + /// + public record I18n + { + /// + /// 语言编码(IETF BCP 47) + /// 必填:是 + /// 示例值:zh-CN + /// + [JsonPropertyName("lang")] + public string Lang { get; set; } = string.Empty; + + /// + /// 文本内容 + /// 必填:是 + /// 示例值:中文示例 + /// + [JsonPropertyName("value")] + public string Value { get; set; } = string.Empty; + } + } + + /// + /// 主要地址 + /// 必填:是 + /// 示例值:true + /// + [JsonPropertyName("is_primary")] + public bool IsPrimary { get; set; } + + /// + /// 公开地址 + /// 必填:是 + /// 示例值:true + /// + [JsonPropertyName("is_public")] + public bool IsPublic { get; set; } + + /// + /// 自定义字段 + /// 必填:否 + /// + [JsonPropertyName("custom_fields")] + public CustomFieldData[]? CustomFields { get; set; } + + /// + /// 自定义字段 + /// + public record CustomFieldData + { + /// + /// 自定义字段 apiname,即自定义字段的唯一标识 + /// 必填:是 + /// 示例值:name + /// + [JsonPropertyName("custom_api_name")] + public string CustomApiName { get; set; } = string.Empty; + + /// + /// 自定义字段名称 + /// 必填:否 + /// + [JsonPropertyName("name")] + public CustomName? Name { get; set; } + + /// + /// 自定义字段名称 + /// + public record CustomName + { + /// + /// 中文 + /// 必填:否 + /// 示例值:自定义姓名 + /// + [JsonPropertyName("zh_cn")] + public string? ZhCn { get; set; } + + /// + /// 英文 + /// 必填:否 + /// 示例值:Custom Name + /// + [JsonPropertyName("en_us")] + public string? EnUs { get; set; } + } + + /// + /// 自定义字段类型 + /// 值类型说明: + /// - 1:文本 Text,“文本”和“超链接”属于该类型 + /// - 2:布尔 Boolean + /// - 3:数字 Number + /// - 4:枚举 Option,“单选”和“多选”为该类型 + /// - 5:查找 Lookup,“人员(单选)”、“人员(多选)”和个人信息中的自定义分组为该类型 + /// - 6:自动编码 Autonumber + /// - 7:日期时间 Datetime + /// - 8:附件 Attachment,“附件单选”和“附件多选”为该类型 + /// - 9:图片 Image + /// - 10:计算字段 Calculated + /// - 11:反向查找 Backlookup + /// 必填:否 + /// 示例值:1 + /// + [JsonPropertyName("type")] + public int? Type { get; set; } + + /// + /// 字段值,是 json 转义后的字符串,根据元数据定义不同,字段格式不同(如 123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05") + /// 必填:是 + /// 示例值:\"231\" + /// + [JsonPropertyName("value")] + public string Value { get; set; } = string.Empty; + } + } + + /// + /// 邮箱列表 + /// 必填:否 + /// + [JsonPropertyName("email_list")] + public Email[]? EmailLists { get; set; } + + /// + /// 邮箱列表 + /// + public record Email + { + /// + /// 邮箱地址 + /// 必填:是 + /// 示例值:1234567@bytedance.com + /// + [JsonPropertyName("email")] + public string EmailSuffix { get; set; } = string.Empty; + + /// + /// 是否为主要邮箱 + /// 必填:否 + /// 示例值:true + /// + [JsonPropertyName("is_primary")] + public bool? IsPrimary { get; set; } + + /// + /// 是否为公开邮箱 + /// 必填:否 + /// 示例值:true + /// + [JsonPropertyName("is_public")] + public bool? IsPublic { get; set; } + + /// + /// 邮箱用途,枚举值可通过文档[枚举常量介绍](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/feishu-people-enum-constant)邮箱用途(email_usage)枚举定义获得 + /// 必填:否 + /// + [JsonPropertyName("email_usage")] + public Enum? EmailUsage { get; set; } + + /// + /// 邮箱用途,枚举值可通过文档[枚举常量介绍](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/feishu-people-enum-constant)邮箱用途(email_usage)枚举定义获得 + /// + public record Enum + { + /// + /// 枚举值 + /// 必填:是 + /// 示例值:phone_type + /// + [JsonPropertyName("enum_name")] + public string EnumName { get; set; } = string.Empty; + + /// + /// 枚举多语展示 + /// 必填:否 + /// + [JsonPropertyName("display")] + public I18n[]? Displies { get; set; } + + /// + /// 枚举多语展示 + /// + public record I18n + { + /// + /// 语言编码(IETF BCP 47) + /// 必填:是 + /// 示例值:zh-CN + /// + [JsonPropertyName("lang")] + public string Lang { get; set; } = string.Empty; + + /// + /// 文本内容 + /// 必填:是 + /// 示例值:中文示例 + /// + [JsonPropertyName("value")] + public string Value { get; set; } = string.Empty; + } + } + } + + /// + /// 工作经历列表 + /// 必填:否 + /// + [JsonPropertyName("work_experience_list")] + public WorkExperienceInfo[]? WorkExperienceLists { get; set; } + + /// + /// 工作经历列表 + /// + public record WorkExperienceInfo + { + /// + /// 公司 / 组织 + /// 必填:否 + /// + [JsonPropertyName("company_organization")] + public I18n[]? CompanyOrganizations { get; set; } + + /// + /// 公司 / 组织 + /// + public record I18n + { + /// + /// 语言编码(IETF BCP 47) + /// 必填:是 + /// 示例值:zh-CN + /// + [JsonPropertyName("lang")] + public string Lang { get; set; } = string.Empty; + + /// + /// 文本内容 + /// 必填:是 + /// 示例值:中文示例 + /// + [JsonPropertyName("value")] + public string Value { get; set; } = string.Empty; + } + + /// + /// 部门 + /// 必填:否 + /// + [JsonPropertyName("department")] + public I18n[]? Departments { get; set; } + + /// + /// 岗位 + /// 必填:否 + /// + [JsonPropertyName("job")] + public I18n[]? Jobs { get; set; } + + /// + /// 工作描述 + /// 必填:否 + /// + [JsonPropertyName("description")] + public I18n[]? Descriptions { get; set; } + + /// + /// 开始日期,时间格式为 2023-09-01 + /// 必填:否 + /// 示例值:2020-01-01 + /// + [JsonPropertyName("start_date")] + public string? StartDate { get; set; } + + /// + /// 结束日期,时间格式为 2023-09-01 + /// 必填:否 + /// 示例值:2020-01-01 + /// + [JsonPropertyName("end_date")] + public string? EndDate { get; set; } + + /// + /// 自定义字段 + /// 必填:否 + /// + [JsonPropertyName("custom_fields")] + public CustomFieldData[]? CustomFields { get; set; } + + /// + /// 自定义字段 + /// + public record CustomFieldData + { + /// + /// 自定义字段 apiname,即自定义字段的唯一标识 + /// 必填:是 + /// 示例值:name + /// + [JsonPropertyName("custom_api_name")] + public string CustomApiName { get; set; } = string.Empty; + + /// + /// 自定义字段名称 + /// 必填:否 + /// + [JsonPropertyName("name")] + public CustomName? Name { get; set; } + + /// + /// 自定义字段名称 + /// + public record CustomName + { + /// + /// 中文 + /// 必填:否 + /// 示例值:自定义姓名 + /// + [JsonPropertyName("zh_cn")] + public string? ZhCn { get; set; } + + /// + /// 英文 + /// 必填:否 + /// 示例值:Custom Name + /// + [JsonPropertyName("en_us")] + public string? EnUs { get; set; } + } + + /// + /// 自定义字段类型 + /// 值类型说明: + /// - 1:文本 Text,“文本”和“超链接”属于该类型 + /// - 2:布尔 Boolean + /// - 3:数字 Number + /// - 4:枚举 Option,“单选”和“多选”为该类型 + /// - 5:查找 Lookup,“人员(单选)”、“人员(多选)”和个人信息中的自定义分组为该类型 + /// - 6:自动编码 Autonumber + /// - 7:日期时间 Datetime + /// - 8:附件 Attachment,“附件单选”和“附件多选”为该类型 + /// - 9:图片 Image + /// - 10:计算字段 Calculated + /// - 11:反向查找 Backlookup + /// 必填:否 + /// 示例值:1 + /// + [JsonPropertyName("type")] + public int? Type { get; set; } + + /// + /// 字段值,是 json 转义后的字符串,根据元数据定义不同,字段格式不同(如 123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05") + /// 必填:是 + /// 示例值:\"231\" + /// + [JsonPropertyName("value")] + public string Value { get; set; } = string.Empty; + } + } + + /// + /// 教育经历列表 + /// 必填:否 + /// + [JsonPropertyName("education_list")] + public Education[]? EducationLists { get; set; } + + /// + /// 教育经历列表 + /// + public record Education + { + /// + /// 学校 + /// 必填:是 + /// + [JsonPropertyName("school")] + public I18n[] Schools { get; set; } = Array.Empty(); + + /// + /// 学校 + /// + public record I18n + { + /// + /// 语言编码(IETF BCP 47) + /// 必填:是 + /// 示例值:zh-CN + /// + [JsonPropertyName("lang")] + public string Lang { get; set; } = string.Empty; + + /// + /// 文本内容 + /// 必填:是 + /// 示例值:中文示例 + /// + [JsonPropertyName("value")] + public string Value { get; set; } = string.Empty; + } + + /// + /// 学历,枚举值可通过文档[枚举常量介绍](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/feishu-people-enum-constant)学历(level_of_education)枚举定义获得 + /// 必填:否 + /// + [JsonPropertyName("level_of_education")] + public Enum? LevelOfEducation { get; set; } + + /// + /// 学历,枚举值可通过文档[枚举常量介绍](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/feishu-people-enum-constant)学历(level_of_education)枚举定义获得 + /// + public record Enum + { + /// + /// 枚举值 + /// 必填:是 + /// 示例值:phone_type + /// + [JsonPropertyName("enum_name")] + public string EnumName { get; set; } = string.Empty; + + /// + /// 枚举多语展示 + /// 必填:否 + /// + [JsonPropertyName("display")] + public I18n[]? Displies { get; set; } + + /// + /// 枚举多语展示 + /// + public record I18n + { + /// + /// 语言编码(IETF BCP 47) + /// 必填:是 + /// 示例值:zh-CN + /// + [JsonPropertyName("lang")] + public string Lang { get; set; } = string.Empty; + + /// + /// 文本内容 + /// 必填:是 + /// 示例值:中文示例 + /// + [JsonPropertyName("value")] + public string Value { get; set; } = string.Empty; + } + } + + /// + /// 开始日期,时间格式为 2023-09-01 + /// 必填:否 + /// 示例值:2011-09-01 + /// + [JsonPropertyName("start_date")] + public string? StartDate { get; set; } + + /// + /// 结束日期,时间格式为 2023-09-01 + /// 必填:否 + /// 示例值:2015-06-30 + /// + [JsonPropertyName("end_date")] + public string? EndDate { get; set; } + + /// + /// 专业 + /// 必填:否 + /// + [JsonPropertyName("field_of_study")] + public I18n[]? FieldOfStuies { get; set; } + + /// + /// 学位 + /// 必填:否 + /// + [JsonPropertyName("degree")] + public Enum? Degree { get; set; } + + /// + /// 学校名称 + /// 必填:否 + /// + [JsonPropertyName("school_name")] + public Enum? SchoolName { get; set; } + + /// + /// 专业名称 + /// 必填:否 + /// + [JsonPropertyName("field_of_study_name")] + public Enum? FieldOfStudyName { get; set; } + + /// + /// 国家地区ID + /// 必填:否 + /// 示例值:1 + /// + [JsonPropertyName("country_region_id")] + public string? CountryRegionId { get; set; } + + /// + /// 预期结束日期 + /// 必填:否 + /// 示例值:2011-09-01 + /// + [JsonPropertyName("expected_end_date")] + public string? ExpectedEndDate { get; set; } + + /// + /// 自定义字段 + /// 必填:否 + /// + [JsonPropertyName("custom_fields")] + public CustomFieldData[]? CustomFields { get; set; } + + /// + /// 自定义字段 + /// + public record CustomFieldData + { + /// + /// 自定义字段 apiname,即自定义字段的唯一标识 + /// 必填:是 + /// 示例值:name + /// + [JsonPropertyName("custom_api_name")] + public string CustomApiName { get; set; } = string.Empty; + + /// + /// 自定义字段名称 + /// 必填:否 + /// + [JsonPropertyName("name")] + public CustomName? Name { get; set; } + + /// + /// 自定义字段名称 + /// + public record CustomName + { + /// + /// 中文 + /// 必填:否 + /// 示例值:自定义姓名 + /// + [JsonPropertyName("zh_cn")] + public string? ZhCn { get; set; } + + /// + /// 英文 + /// 必填:否 + /// 示例值:Custom Name + /// + [JsonPropertyName("en_us")] + public string? EnUs { get; set; } + } + + /// + /// 自定义字段类型 + /// 值类型说明: + /// - 1:文本 Text,“文本”和“超链接”属于该类型 + /// - 2:布尔 Boolean + /// - 3:数字 Number + /// - 4:枚举 Option,“单选”和“多选”为该类型 + /// - 5:查找 Lookup,“人员(单选)”、“人员(多选)”和个人信息中的自定义分组为该类型 + /// - 6:自动编码 Autonumber + /// - 7:日期时间 Datetime + /// - 8:附件 Attachment,“附件单选”和“附件多选”为该类型 + /// - 9:图片 Image + /// - 10:计算字段 Calculated + /// - 11:反向查找 Backlookup + /// 必填:否 + /// 示例值:1 + /// + [JsonPropertyName("type")] + public int? Type { get; set; } + + /// + /// 字段值,是 json 转义后的字符串,根据元数据定义不同,字段格式不同(如 123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05") + /// 必填:是 + /// 示例值:\"231\" + /// + [JsonPropertyName("value")] + public string Value { get; set; } = string.Empty; + } + } + + /// + /// 银行账户 + /// 必填:否 + /// + [JsonPropertyName("bank_account_list")] + public BankAccount[]? BankAccountLists { get; set; } + + /// + /// 银行账户 + /// + public record BankAccount + { + /// + /// 银行名称 + /// 必填:否 + /// 示例值:中国农业银行 + /// + [JsonPropertyName("bank_name")] + public string? BankName { get; set; } + + /// + /// 银行账号 + /// 必填:是 + /// 示例值:6231200000001223 + /// + [JsonPropertyName("bank_account_number")] + public string BankAccountNumber { get; set; } = string.Empty; + + /// + /// 开户人姓名 + /// 必填:是 + /// 示例值:孟十五 + /// + [JsonPropertyName("account_holder")] + public string AccountHolder { get; set; } = string.Empty; + + /// + /// 支行名称 + /// 必填:否 + /// 示例值:中国农业银行支行 + /// + [JsonPropertyName("branch_name")] + public string? BranchName { get; set; } + + /// + /// 国家 / 地区,可以通过接口[查询国家/地区信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region/search)获取详情 + /// 必填:否 + /// 示例值:12 + /// + [JsonPropertyName("country_region_id")] + public string? CountryRegionId { get; set; } + + /// + /// 银行卡用途,枚举值可通过文档[枚举常量介绍](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/feishu-people-enum-constant)银行卡用途(bank_account_usage)枚举定义获得 + /// 必填:否 + /// + [JsonPropertyName("bank_account_usage")] + public Enum[]? BankAccountUsages { get; set; } + + /// + /// 银行卡用途,枚举值可通过文档[枚举常量介绍](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/feishu-people-enum-constant)银行卡用途(bank_account_usage)枚举定义获得 + /// + public record Enum + { + /// + /// 枚举值 + /// 必填:是 + /// 示例值:phone_type + /// + [JsonPropertyName("enum_name")] + public string EnumName { get; set; } = string.Empty; + + /// + /// 枚举多语展示 + /// 必填:否 + /// + [JsonPropertyName("display")] + public I18n[]? Displies { get; set; } + + /// + /// 枚举多语展示 + /// + public record I18n + { + /// + /// 语言编码(IETF BCP 47) + /// 必填:是 + /// 示例值:zh-CN + /// + [JsonPropertyName("lang")] + public string Lang { get; set; } = string.Empty; + + /// + /// 文本内容 + /// 必填:是 + /// 示例值:中文示例 + /// + [JsonPropertyName("value")] + public string Value { get; set; } = string.Empty; + } + } + + /// + /// 银行卡类型,枚举值可通过文档[枚举常量介绍](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/feishu-people-enum-constant)银行卡类型(bank_account_type)枚举定义获得 + /// 必填:否 + /// + [JsonPropertyName("bank_account_type")] + public Enum? BankAccountType { get; set; } + + /// + /// 货币id + /// 必填:否 + /// 示例值:12QueryCountryRegionSubdivisionDataReq + /// + [JsonPropertyName("currency_id")] + public string? CurrencyId { get; set; } + + /// + /// 自定义字段 + /// 必填:否 + /// + [JsonPropertyName("custom_fields")] + public CustomFieldData[]? CustomFields { get; set; } + + /// + /// 自定义字段 + /// + public record CustomFieldData + { + /// + /// 自定义字段 apiname,即自定义字段的唯一标识 + /// 必填:是 + /// 示例值:name + /// + [JsonPropertyName("custom_api_name")] + public string CustomApiName { get; set; } = string.Empty; + + /// + /// 自定义字段名称 + /// 必填:否 + /// + [JsonPropertyName("name")] + public CustomName? Name { get; set; } + + /// + /// 自定义字段名称 + /// + public record CustomName + { + /// + /// 中文 + /// 必填:否 + /// 示例值:自定义姓名 + /// + [JsonPropertyName("zh_cn")] + public string? ZhCn { get; set; } + + /// + /// 英文 + /// 必填:否 + /// 示例值:Custom Name + /// + [JsonPropertyName("en_us")] + public string? EnUs { get; set; } + } + + /// + /// 自定义字段类型 + /// 值类型说明: + /// - 1:文本 Text,“文本”和“超链接”属于该类型 + /// - 2:布尔 Boolean + /// - 3:数字 Number + /// - 4:枚举 Option,“单选”和“多选”为该类型 + /// - 5:查找 Lookup,“人员(单选)”、“人员(多选)”和个人信息中的自定义分组为该类型 + /// - 6:自动编码 Autonumber + /// - 7:日期时间 Datetime + /// - 8:附件 Attachment,“附件单选”和“附件多选”为该类型 + /// - 9:图片 Image + /// - 10:计算字段 Calculated + /// - 11:反向查找 Backlookup + /// 必填:否 + /// 示例值:1 + /// + [JsonPropertyName("type")] + public int? Type { get; set; } + + /// + /// 字段值,是 json 转义后的字符串,根据元数据定义不同,字段格式不同(如 123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05") + /// 必填:是 + /// 示例值:\"231\" + /// + [JsonPropertyName("value")] + public string Value { get; set; } = string.Empty; + } + } + + /// + /// 证件 + /// 必填:否 + /// + [JsonPropertyName("national_id_list")] + public NationalId[]? NationalIdLists { get; set; } + + /// + /// 证件 + /// + public record NationalId + { + /// + /// 国家证件类型 + /// 必填:是 + /// 示例值:6863330041896371725 + /// + [JsonPropertyName("national_id_type_id")] + public string NationalIdTypeId { get; set; } = string.Empty; + + /// + /// 证件号码 + /// 必填:是 + /// 示例值:1231131333 + /// + [JsonPropertyName("national_id_number")] + public string NationalIdNumber { get; set; } = string.Empty; + + /// + /// 证件签发日期 + /// 必填:否 + /// 示例值:2020-04-01 + /// + [JsonPropertyName("issue_date")] + public string? IssueDate { get; set; } + + /// + /// 证件到期日期 + /// 必填:否 + /// 示例值:2020-05-21 + /// + [JsonPropertyName("expiration_date")] + public string? ExpirationDate { get; set; } + + /// + /// 国家 / 地区,可以通过接口[查询国家/地区信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region/search)获取详情 + /// 必填:是 + /// 示例值:6862995757234914824 + /// + [JsonPropertyName("country_region_id")] + public string CountryRegionId { get; set; } = string.Empty; + + /// + /// 证件签发机构 + /// 必填:否 + /// 示例值:北京市公安局 + /// + [JsonPropertyName("issued_by")] + public string? IssuedBy { get; set; } + + /// + /// 自定义字段 + /// 必填:否 + /// + [JsonPropertyName("custom_fields")] + public CustomFieldData[]? CustomFields { get; set; } + + /// + /// 自定义字段 + /// + public record CustomFieldData + { + /// + /// 自定义字段 apiname,即自定义字段的唯一标识 + /// 必填:是 + /// 示例值:name + /// + [JsonPropertyName("custom_api_name")] + public string CustomApiName { get; set; } = string.Empty; + + /// + /// 自定义字段名称 + /// 必填:否 + /// + [JsonPropertyName("name")] + public CustomName? Name { get; set; } + + /// + /// 自定义字段名称 + /// + public record CustomName + { + /// + /// 中文 + /// 必填:否 + /// 示例值:自定义姓名 + /// + [JsonPropertyName("zh_cn")] + public string? ZhCn { get; set; } + + /// + /// 英文 + /// 必填:否 + /// 示例值:Custom Name + /// + [JsonPropertyName("en_us")] + public string? EnUs { get; set; } + } + + /// + /// 自定义字段类型 + /// 值类型说明: + /// - 1:文本 Text,“文本”和“超链接”属于该类型 + /// - 2:布尔 Boolean + /// - 3:数字 Number + /// - 4:枚举 Option,“单选”和“多选”为该类型 + /// - 5:查找 Lookup,“人员(单选)”、“人员(多选)”和个人信息中的自定义分组为该类型 + /// - 6:自动编码 Autonumber + /// - 7:日期时间 Datetime + /// - 8:附件 Attachment,“附件单选”和“附件多选”为该类型 + /// - 9:图片 Image + /// - 10:计算字段 Calculated + /// - 11:反向查找 Backlookup + /// 必填:否 + /// 示例值:1 + /// + [JsonPropertyName("type")] + public int? Type { get; set; } + + /// + /// 字段值,是 json 转义后的字符串,根据元数据定义不同,字段格式不同(如 123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05") + /// 必填:是 + /// 示例值:\"231\" + /// + [JsonPropertyName("value")] + public string Value { get; set; } = string.Empty; + } + } + + /// + /// 家庭成员列表 + /// 必填:否 + /// + [JsonPropertyName("dependent_list")] + public Dependent[]? DependentLists { get; set; } + + /// + /// 家庭成员列表 + /// + public record Dependent + { + /// + /// 姓名 + /// 必填:否 + /// + [JsonPropertyName("name")] + public PersonName? Name { get; set; } + + /// + /// 姓名 + /// + public record PersonName + { + /// + /// 姓 - 本地文字 + /// 必填:否 + /// 示例值:黄 + /// + [JsonPropertyName("local_primary")] + public string? LocalPrimary { get; set; } + + /// + /// 名 - 本地文字 + /// 必填:否 + /// 示例值:四 + /// + [JsonPropertyName("local_first_name")] + public string? LocalFirstName { get; set; } + + /// + /// 国家 / 地区,可以通过接口[查询国家/地区信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region/search)获取详情 + /// 必填:是 + /// 示例值:6862995757234914824 + /// + [JsonPropertyName("country_region_id")] + public string CountryRegionId { get; set; } = string.Empty; + + /// + /// 姓名类型,枚举值可通过文档[枚举常量介绍](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/feishu-people-enum-constant)姓名类型(name_type)枚举定义获得 + /// 必填:是 + /// + [JsonPropertyName("name_type")] + public Enum NameType { get; set; } = new(); + + /// + /// 姓名类型,枚举值可通过文档[枚举常量介绍](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/feishu-people-enum-constant)姓名类型(name_type)枚举定义获得 + /// + public record Enum + { + /// + /// 枚举值 + /// 必填:是 + /// 示例值:phone_type + /// + [JsonPropertyName("enum_name")] + public string EnumName { get; set; } = string.Empty; + + /// + /// 枚举多语展示 + /// 必填:否 + /// + [JsonPropertyName("display")] + public I18n[]? Displies { get; set; } + + /// + /// 枚举多语展示 + /// + public record I18n + { + /// + /// 语言编码(IETF BCP 47) + /// 必填:是 + /// 示例值:zh-CN + /// + [JsonPropertyName("lang")] + public string Lang { get; set; } = string.Empty; + + /// + /// 文本内容 + /// 必填:是 + /// 示例值:中文示例 + /// + [JsonPropertyName("value")] + public string Value { get; set; } = string.Empty; + } + } + + /// + /// 名 - 第二本地文字 + /// 必填:否 + /// 示例值:五 + /// + [JsonPropertyName("local_first_name_2")] + public string? LocalFirstName2 { get; set; } + + /// + /// 姓 - 第二本地文字 + /// 必填:否 + /// 示例值:王 + /// + [JsonPropertyName("local_primary_2")] + public string? LocalPrimary2 { get; set; } + + /// + /// 补充姓名类型,枚举值可查询[获取字段详情](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口获取,按如下参数查询即可: + /// - custom_api_name:additional_name_type + /// - object_api_name:person_name + /// 必填:否 + /// + [JsonPropertyName("additional_name_type")] + public Enum? AdditionalNameType { get; set; } + + /// + /// + /// 必填:否 + /// 示例值:帅 + /// + [JsonPropertyName("first_name")] + public string? FirstName { get; set; } + + /// + /// 全名 + /// 必填:否 + /// 示例值:王大帅 + /// + [JsonPropertyName("full_name")] + public string? FullName { get; set; } + + /// + /// 姓氏称谓 + /// 必填:否 + /// 示例值:王 + /// + [JsonPropertyName("hereditary")] + public string? Hereditary { get; set; } + + /// + /// 自定义姓名(未传入时,姓名将默认根据所属国家 / 地区规则对相关姓、名字段拼接) + /// 必填:否 + /// 示例值:王大帅 + /// + [JsonPropertyName("custom_name")] + public string? CustomName { get; set; } + + /// + /// 本地文字的自定义姓名(未传入时,本地文字的姓名将默认根据所属国家 / 地区规则对本地文字的相关姓、名字段拼接) + /// 必填:否 + /// 示例值:王大帅 + /// + [JsonPropertyName("custom_local_name")] + public string? CustomLocalName { get; set; } + + /// + /// 中间名 + /// 必填:否 + /// 示例值:大 + /// + [JsonPropertyName("middle_name")] + public string? MiddleName { get; set; } + + /// + /// + /// 必填:否 + /// 示例值:王 + /// + [JsonPropertyName("name_primary")] + public string? NamePrimary { get; set; } + + /// + /// 第二姓氏 + /// 必填:否 + /// 示例值:王 + /// + [JsonPropertyName("secondary")] + public string? Secondary { get; set; } + + /// + /// 尊称,枚举值可查询[获取字段详情](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口获取,按如下参数查询即可: + /// - custom_api_name:social + /// - object_api_name:person_name + /// 必填:否 + /// 示例值:王大帅 + /// + [JsonPropertyName("social")] + public Enum? Social { get; set; } + + /// + /// 婚后姓氏 + /// 必填:否 + /// 示例值:王 + /// + [JsonPropertyName("tertiary")] + public string? Tertiary { get; set; } + + /// + /// 头衔,枚举值可查询[获取字段详情](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口获取,按如下参数查询即可: + /// - custom_api_name:title + /// - object_api_name:person_name + /// 必填:否 + /// 示例值:王 + /// + [JsonPropertyName("title")] + public Enum? Title { get; set; } + + /// + /// 本地中间名 + /// 必填:否 + /// 示例值:大 + /// + [JsonPropertyName("local_middle_name")] + public string? LocalMiddleName { get; set; } + + /// + /// 第二姓氏 - 本地文字 + /// 必填:否 + /// 示例值:王 + /// + [JsonPropertyName("local_secondary")] + public string? LocalSecondary { get; set; } + + /// + /// 展示姓名(本地和西方文字) + /// 必填:否 + /// 示例值:王大帅 + /// + [JsonPropertyName("display_name_local_and_western_script")] + public string? DisplayNameLocalAndWesternScript { get; set; } + + /// + /// 展示姓名(本地文字) + /// 必填:否 + /// 示例值:王大帅 + /// + [JsonPropertyName("display_name_local_script")] + public string? DisplayNameLocalScript { get; set; } + + /// + /// 展示姓名(西方文字) + /// 必填:否 + /// 示例值:王大帅 + /// + [JsonPropertyName("display_name_western_script")] + public string? DisplayNameWesternScript { get; set; } + } + + /// + /// 关系 + /// 必填:是 + /// + [JsonPropertyName("relationship")] + public Enum Relationship { get; set; } = new(); + + /// + /// 关系 + /// + public record Enum + { + /// + /// 枚举值 + /// 必填:是 + /// 示例值:phone_type + /// + [JsonPropertyName("enum_name")] + public string EnumName { get; set; } = string.Empty; + + /// + /// 枚举多语展示 + /// 必填:否 + /// + [JsonPropertyName("display")] + public I18n[]? Displies { get; set; } + + /// + /// 枚举多语展示 + /// + public record I18n + { + /// + /// 语言编码(IETF BCP 47) + /// 必填:是 + /// 示例值:zh-CN + /// + [JsonPropertyName("lang")] + public string Lang { get; set; } = string.Empty; + + /// + /// 文本内容 + /// 必填:是 + /// 示例值:中文示例 + /// + [JsonPropertyName("value")] + public string Value { get; set; } = string.Empty; + } + } + + /// + /// 性别 + /// 必填:否 + /// + [JsonPropertyName("gender")] + public Enum? Gender { get; set; } + + /// + /// 生日 + /// 必填:否 + /// 示例值:2020-01-01 + /// + [JsonPropertyName("date_of_birth")] + public string? DateOfBirth { get; set; } + + /// + /// 证件号码 + /// 必填:否 + /// + [JsonPropertyName("national_id_list")] + public NationalId[]? NationalIdLists { get; set; } + + /// + /// 证件号码 + /// + public record NationalId + { + /// + /// 国家证件类型 + /// 必填:是 + /// 示例值:6863330041896371725 + /// + [JsonPropertyName("national_id_type_id")] + public string NationalIdTypeId { get; set; } = string.Empty; + + /// + /// 证件号码 + /// 必填:是 + /// 示例值:1231131333 + /// + [JsonPropertyName("national_id_number")] + public string NationalIdNumber { get; set; } = string.Empty; + + /// + /// 证件签发日期 + /// 必填:否 + /// 示例值:2020-04-01 + /// + [JsonPropertyName("issue_date")] + public string? IssueDate { get; set; } + + /// + /// 证件到期日期 + /// 必填:否 + /// 示例值:2020-05-21 + /// + [JsonPropertyName("expiration_date")] + public string? ExpirationDate { get; set; } + + /// + /// 国家 / 地区,可以通过接口[查询国家/地区信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region/search)获取详情 + /// 必填:是 + /// 示例值:6862995757234914824 + /// + [JsonPropertyName("country_region_id")] + public string CountryRegionId { get; set; } = string.Empty; + + /// + /// 证件签发机构 + /// 必填:否 + /// 示例值:北京市公安局 + /// + [JsonPropertyName("issued_by")] + public string? IssuedBy { get; set; } + + /// + /// 自定义字段 + /// 必填:否 + /// + [JsonPropertyName("custom_fields")] + public CustomFieldData[]? CustomFields { get; set; } + + /// + /// 自定义字段 + /// + public record CustomFieldData + { + /// + /// 自定义字段 apiname,即自定义字段的唯一标识 + /// 必填:是 + /// 示例值:name + /// + [JsonPropertyName("custom_api_name")] + public string CustomApiName { get; set; } = string.Empty; + + /// + /// 自定义字段名称 + /// 必填:否 + /// + [JsonPropertyName("name")] + public CustomName? Name { get; set; } + + /// + /// 自定义字段名称 + /// + public record CustomName + { + /// + /// 中文 + /// 必填:否 + /// 示例值:自定义姓名 + /// + [JsonPropertyName("zh_cn")] + public string? ZhCn { get; set; } + + /// + /// 英文 + /// 必填:否 + /// 示例值:Custom Name + /// + [JsonPropertyName("en_us")] + public string? EnUs { get; set; } + } + + /// + /// 自定义字段类型 + /// 值类型说明: + /// - 1:文本 Text,“文本”和“超链接”属于该类型 + /// - 2:布尔 Boolean + /// - 3:数字 Number + /// - 4:枚举 Option,“单选”和“多选”为该类型 + /// - 5:查找 Lookup,“人员(单选)”、“人员(多选)”和个人信息中的自定义分组为该类型 + /// - 6:自动编码 Autonumber + /// - 7:日期时间 Datetime + /// - 8:附件 Attachment,“附件单选”和“附件多选”为该类型 + /// - 9:图片 Image + /// - 10:计算字段 Calculated + /// - 11:反向查找 Backlookup + /// 必填:否 + /// 示例值:1 + /// + [JsonPropertyName("type")] + public int? Type { get; set; } + + /// + /// 字段值,是 json 转义后的字符串,根据元数据定义不同,字段格式不同(如 123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05") + /// 必填:是 + /// 示例值:\"231\" + /// + [JsonPropertyName("value")] + public string Value { get; set; } = string.Empty; + } + } + + /// + /// 配偶工作状态 + /// 必填:否 + /// + [JsonPropertyName("spouses_working_status")] + public Enum? SpousesWorkingStatus { get; set; } + + /// + /// 包含家属医疗保险 + /// 必填:否 + /// 示例值:true + /// + [JsonPropertyName("is_this_person_covered_by_health_insurance")] + public bool? IsThisPersonCoveredByHealthInsurance { get; set; } + + /// + /// 允许家属抵扣税款 + /// 必填:否 + /// 示例值:false + /// + [JsonPropertyName("is_this_person_allowed_for_tax_deduction")] + public bool? IsThisPersonAllowedForTaxDeduction { get; set; } + + /// + /// 自定义字段 + /// 必填:否 + /// + [JsonPropertyName("custom_fields")] + public CustomFieldData[]? CustomFields { get; set; } + + /// + /// 自定义字段 + /// + public record CustomFieldData + { + /// + /// 自定义字段 apiname,即自定义字段的唯一标识 + /// 必填:是 + /// 示例值:name + /// + [JsonPropertyName("custom_api_name")] + public string CustomApiName { get; set; } = string.Empty; + + /// + /// 自定义字段名称 + /// 必填:否 + /// + [JsonPropertyName("name")] + public CustomName? Name { get; set; } + + /// + /// 自定义字段名称 + /// + public record CustomName + { + /// + /// 中文 + /// 必填:否 + /// 示例值:自定义姓名 + /// + [JsonPropertyName("zh_cn")] + public string? ZhCn { get; set; } + + /// + /// 英文 + /// 必填:否 + /// 示例值:Custom Name + /// + [JsonPropertyName("en_us")] + public string? EnUs { get; set; } + } + + /// + /// 自定义字段类型 + /// 值类型说明: + /// - 1:文本 Text,“文本”和“超链接”属于该类型 + /// - 2:布尔 Boolean + /// - 3:数字 Number + /// - 4:枚举 Option,“单选”和“多选”为该类型 + /// - 5:查找 Lookup,“人员(单选)”、“人员(多选)”和个人信息中的自定义分组为该类型 + /// - 6:自动编码 Autonumber + /// - 7:日期时间 Datetime + /// - 8:附件 Attachment,“附件单选”和“附件多选”为该类型 + /// - 9:图片 Image + /// - 10:计算字段 Calculated + /// - 11:反向查找 Backlookup + /// 必填:否 + /// 示例值:1 + /// + [JsonPropertyName("type")] + public int? Type { get; set; } + + /// + /// 字段值,是 json 转义后的字符串,根据元数据定义不同,字段格式不同(如 123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05") + /// 必填:是 + /// 示例值:\"231\" + /// + [JsonPropertyName("value")] + public string Value { get; set; } = string.Empty; + } + + /// + /// 家庭成员姓名 + /// 必填:否 + /// 示例值:张三 + /// + [JsonPropertyName("dependent_name")] + public string? DependentName { get; set; } + + /// + /// 工作单位 + /// 必填:否 + /// 示例值:海淀区交警大队 + /// + [JsonPropertyName("employer")] + public string? Employer { get; set; } + + /// + /// 岗位 + /// 必填:否 + /// 示例值:保安 + /// + [JsonPropertyName("job")] + public string? Job { get; set; } + + /// + /// 电话 + /// 必填:否 + /// + [JsonPropertyName("phone")] + public DependentPhone? Phone { get; set; } + + /// + /// 电话 + /// + public record DependentPhone + { + /// + /// 国家区号,枚举值可通过文档[枚举常量介绍](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/feishu-people-enum-constant)手机区号(international_area_code)枚举定义获得 + /// 必填:否 + /// + [JsonPropertyName("international_area_code")] + public Enum? InternationalAreaCode { get; set; } + + /// + /// 国家区号,枚举值可通过文档[枚举常量介绍](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/feishu-people-enum-constant)手机区号(international_area_code)枚举定义获得 + /// + public record Enum + { + /// + /// 枚举值 + /// 必填:是 + /// 示例值:phone_type + /// + [JsonPropertyName("enum_name")] + public string EnumName { get; set; } = string.Empty; + + /// + /// 枚举多语展示 + /// 必填:否 + /// + [JsonPropertyName("display")] + public I18n[]? Displies { get; set; } + + /// + /// 枚举多语展示 + /// + public record I18n + { + /// + /// 语言编码(IETF BCP 47) + /// 必填:是 + /// 示例值:zh-CN + /// + [JsonPropertyName("lang")] + public string Lang { get; set; } = string.Empty; + + /// + /// 文本内容 + /// 必填:是 + /// 示例值:中文示例 + /// + [JsonPropertyName("value")] + public string Value { get; set; } = string.Empty; + } + } + + /// + /// 电话号码 + /// 必填:是 + /// 示例值:010-12345678 + /// + [JsonPropertyName("phone_number")] + public string PhoneNumber { get; set; } = string.Empty; + + /// + /// 完整电话号码 + /// 必填:否 + /// 示例值:+86 010-12345678 + /// + [JsonPropertyName("formatted_phone_number")] + public string? FormattedPhoneNumber { get; set; } + + /// + /// 设备类型 + /// 必填:否 + /// + [JsonPropertyName("device_type")] + public Enum? DeviceType { get; set; } + + /// + /// 电话用途,枚举值可通过文档[枚举常量介绍](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/feishu-people-enum-constant)电话用途(phone_usage)枚举定义获得 + /// 必填:否 + /// + [JsonPropertyName("phone_usage")] + public Enum? PhoneUsage { get; set; } + + /// + /// 主要电话 + /// 必填:否 + /// 示例值:true + /// + [JsonPropertyName("is_primary")] + public bool? IsPrimary { get; set; } + + /// + /// 公开电话 + /// 必填:否 + /// 示例值:true + /// + [JsonPropertyName("is_public")] + public bool? IsPublic { get; set; } + } + + /// + /// 联系地址 + /// 必填:否 + /// + [JsonPropertyName("address")] + public DependentAddress? Address { get; set; } + + /// + /// 联系地址 + /// + public record DependentAddress + { + /// + /// 完整地址(本地文字) + /// 必填:否 + /// 示例值:中国北京北京 + /// + [JsonPropertyName("full_address_local_script")] + public string? FullAddressLocalScript { get; set; } + + /// + /// 完整地址(西方文字) + /// 必填:否 + /// 示例值:Beijing, Beijing, China, + /// + [JsonPropertyName("full_address_western_script")] + public string? FullAddressWesternScript { get; set; } + + /// + /// 地址 ID + /// 必填:否 + /// 示例值:6989822217869624863 + /// + [JsonPropertyName("address_id")] + public string? AddressId { get; set; } + + /// + /// 国家 / 地区,可以通过接口[查询国家/地区信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region/search)获取详情 + /// 必填:是 + /// 示例值:6862995757234914824 + /// + [JsonPropertyName("country_region_id")] + public string CountryRegionId { get; set; } = string.Empty; + + /// + /// 主要行政区ID 可以通过[查询省份/行政区信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region_subdivision/search)接口获取详情 + /// 必填:否 + /// 示例值:6863326815667095047 + /// + [JsonPropertyName("region_id")] + public string? RegionId { get; set; } + + /// + /// 地址行 1 + /// 必填:否 + /// 示例值:丹佛测试地址-纽埃时区 + /// + [JsonPropertyName("address_line1")] + public string? AddressLine1 { get; set; } + + /// + /// 地址行 2 + /// 必填:否 + /// 示例值:PoewH + /// + [JsonPropertyName("address_line2")] + public string? AddressLine2 { get; set; } + + /// + /// 地址行 3 + /// 必填:否 + /// 示例值:PoewH + /// + [JsonPropertyName("address_line3")] + public string? AddressLine3 { get; set; } + + /// + /// 地址行 4 + /// 必填:否 + /// 示例值:jmwJc + /// + [JsonPropertyName("address_line4")] + public string? AddressLine4 { get; set; } + + /// + /// 地址行 5 + /// 必填:否 + /// 示例值:jmwJc + /// + [JsonPropertyName("address_line5")] + public string? AddressLine5 { get; set; } + + /// + /// 地址行 6 + /// 必填:否 + /// 示例值:jmwJc + /// + [JsonPropertyName("address_line6")] + public string? AddressLine6 { get; set; } + + /// + /// 地址行 7 + /// 必填:否 + /// 示例值:jmwJc + /// + [JsonPropertyName("address_line7")] + public string? AddressLine7 { get; set; } + + /// + /// 地址行 8 + /// 必填:否 + /// 示例值:rafSu + /// + [JsonPropertyName("address_line8")] + public string? AddressLine8 { get; set; } + + /// + /// 地址行 9 + /// 必填:否 + /// 示例值:McPRG + /// + [JsonPropertyName("address_line9")] + public string? AddressLine9 { get; set; } + + /// + /// 地址行 1(非拉丁语系的本地文字) + /// 必填:否 + /// 示例值:丹佛测试地址-纽埃时区 + /// + [JsonPropertyName("local_address_line1")] + public string? LocalAddressLine1 { get; set; } + + /// + /// 地址行 2(非拉丁语系的本地文字) + /// 必填:否 + /// 示例值:PoewH + /// + [JsonPropertyName("local_address_line2")] + public string? LocalAddressLine2 { get; set; } + + /// + /// 地址行 3(非拉丁语系的本地文字) + /// 必填:否 + /// 示例值:PoewH + /// + [JsonPropertyName("local_address_line3")] + public string? LocalAddressLine3 { get; set; } + + /// + /// 地址行 4(非拉丁语系的本地文字) + /// 必填:否 + /// 示例值:jmwJc + /// + [JsonPropertyName("local_address_line4")] + public string? LocalAddressLine4 { get; set; } + + /// + /// 地址行 5(非拉丁语系的本地文字) + /// 必填:否 + /// 示例值:jmwJc + /// + [JsonPropertyName("local_address_line5")] + public string? LocalAddressLine5 { get; set; } + + /// + /// 地址行 6(非拉丁语系的本地文字) + /// 必填:否 + /// 示例值:jmwJc + /// + [JsonPropertyName("local_address_line6")] + public string? LocalAddressLine6 { get; set; } + + /// + /// 地址行 7(非拉丁语系的本地文字) + /// 必填:否 + /// 示例值:jmwJc + /// + [JsonPropertyName("local_address_line7")] + public string? LocalAddressLine7 { get; set; } + + /// + /// 地址行 8(非拉丁语系的本地文字) + /// 必填:否 + /// 示例值:rafSu + /// + [JsonPropertyName("local_address_line8")] + public string? LocalAddressLine8 { get; set; } + + /// + /// 地址行 9(非拉丁语系的本地文字) + /// 必填:否 + /// 示例值:McPRG + /// + [JsonPropertyName("local_address_line9")] + public string? LocalAddressLine9 { get; set; } + + /// + /// 邮政编码 + /// 必填:否 + /// 示例值:611530 + /// + [JsonPropertyName("postal_code")] + public string? PostalCode { get; set; } + + /// + /// 地址类型,枚举值可通过文档[枚举常量介绍](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/feishu-people-enum-constant)地址类型(address_type)枚举定义获得 + /// 必填:是 + /// + [JsonPropertyName("address_type_list")] + public Enum[] AddressTypeLists { get; set; } = Array.Empty(); + + /// + /// 地址类型,枚举值可通过文档[枚举常量介绍](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/feishu-people-enum-constant)地址类型(address_type)枚举定义获得 + /// + public record Enum + { + /// + /// 枚举值 + /// 必填:是 + /// 示例值:phone_type + /// + [JsonPropertyName("enum_name")] + public string EnumName { get; set; } = string.Empty; + + /// + /// 枚举多语展示 + /// 必填:否 + /// + [JsonPropertyName("display")] + public I18n[]? Displies { get; set; } + + /// + /// 枚举多语展示 + /// + public record I18n + { + /// + /// 语言编码(IETF BCP 47) + /// 必填:是 + /// 示例值:zh-CN + /// + [JsonPropertyName("lang")] + public string Lang { get; set; } = string.Empty; + + /// + /// 文本内容 + /// 必填:是 + /// 示例值:中文示例 + /// + [JsonPropertyName("value")] + public string Value { get; set; } = string.Empty; + } + } + + /// + /// 主要地址 + /// 必填:是 + /// 示例值:true + /// + [JsonPropertyName("is_primary")] + public bool IsPrimary { get; set; } + + /// + /// 公开地址 + /// 必填:是 + /// 示例值:true + /// + [JsonPropertyName("is_public")] + public bool IsPublic { get; set; } + + /// + /// 自定义字段 + /// 必填:否 + /// + [JsonPropertyName("custom_fields")] + public CustomFieldData[]? CustomFields { get; set; } + + /// + /// 自定义字段 + /// + public record CustomFieldData + { + /// + /// 自定义字段 apiname,即自定义字段的唯一标识 + /// 必填:是 + /// 示例值:name + /// + [JsonPropertyName("custom_api_name")] + public string CustomApiName { get; set; } = string.Empty; + + /// + /// 自定义字段名称 + /// 必填:否 + /// + [JsonPropertyName("name")] + public CustomName? Name { get; set; } + + /// + /// 自定义字段名称 + /// + public record CustomName + { + /// + /// 中文 + /// 必填:否 + /// 示例值:自定义姓名 + /// + [JsonPropertyName("zh_cn")] + public string? ZhCn { get; set; } + + /// + /// 英文 + /// 必填:否 + /// 示例值:Custom Name + /// + [JsonPropertyName("en_us")] + public string? EnUs { get; set; } + } + + /// + /// 自定义字段类型 + /// 值类型说明: + /// - 1:文本 Text,“文本”和“超链接”属于该类型 + /// - 2:布尔 Boolean + /// - 3:数字 Number + /// - 4:枚举 Option,“单选”和“多选”为该类型 + /// - 5:查找 Lookup,“人员(单选)”、“人员(多选)”和个人信息中的自定义分组为该类型 + /// - 6:自动编码 Autonumber + /// - 7:日期时间 Datetime + /// - 8:附件 Attachment,“附件单选”和“附件多选”为该类型 + /// - 9:图片 Image + /// - 10:计算字段 Calculated + /// - 11:反向查找 Backlookup + /// 必填:否 + /// 示例值:1 + /// + [JsonPropertyName("type")] + public int? Type { get; set; } + + /// + /// 字段值,是 json 转义后的字符串,根据元数据定义不同,字段格式不同(如 123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05") + /// 必填:是 + /// 示例值:\"231\" + /// + [JsonPropertyName("value")] + public string Value { get; set; } = string.Empty; + } + } + + /// + /// 出生证明 + /// 必填:否 + /// + [JsonPropertyName("birth_certificate_of_child")] + public File[]? BirthCertificateOfChilds { get; set; } + + /// + /// 出生证明 + /// + public record File + { + /// + /// 上传文件ID + /// 必填:否 + /// 示例值:150018109586e8ea745e47ae8feb3722dbe1d03a181336393633393133303431393831343930373235150200 + /// + [JsonPropertyName("id")] + public string? Id { get; set; } + + /// + /// 文件名 + /// 必填:否 + /// 示例值:document.txt + /// + [JsonPropertyName("name")] + public string? Name { get; set; } + } + } + + /// + /// 紧急联系人列表 + /// 必填:否 + /// + [JsonPropertyName("emergency_contact_list")] + public EmergencyContact[]? EmergencyContactLists { get; set; } + + /// + /// 紧急联系人列表 + /// + public record EmergencyContact + { + /// + /// 姓名 + /// 必填:否 + /// + [JsonPropertyName("name")] + public PersonName? Name { get; set; } + + /// + /// 姓名 + /// + public record PersonName + { + /// + /// 姓 - 本地文字 + /// 必填:否 + /// 示例值:黄 + /// + [JsonPropertyName("local_primary")] + public string? LocalPrimary { get; set; } + + /// + /// 名 - 本地文字 + /// 必填:否 + /// 示例值:四 + /// + [JsonPropertyName("local_first_name")] + public string? LocalFirstName { get; set; } + + /// + /// 国家 / 地区,可以通过接口[查询国家/地区信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region/search)获取详情 + /// 必填:是 + /// 示例值:6862995757234914824 + /// + [JsonPropertyName("country_region_id")] + public string CountryRegionId { get; set; } = string.Empty; + + /// + /// 姓名类型,枚举值可通过文档[枚举常量介绍](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/feishu-people-enum-constant)姓名类型(name_type)枚举定义获得 + /// 必填:是 + /// + [JsonPropertyName("name_type")] + public Enum NameType { get; set; } = new(); + + /// + /// 姓名类型,枚举值可通过文档[枚举常量介绍](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/feishu-people-enum-constant)姓名类型(name_type)枚举定义获得 + /// + public record Enum + { + /// + /// 枚举值 + /// 必填:是 + /// 示例值:phone_type + /// + [JsonPropertyName("enum_name")] + public string EnumName { get; set; } = string.Empty; + + /// + /// 枚举多语展示 + /// 必填:否 + /// + [JsonPropertyName("display")] + public I18n[]? Displies { get; set; } + + /// + /// 枚举多语展示 + /// + public record I18n + { + /// + /// 语言编码(IETF BCP 47) + /// 必填:是 + /// 示例值:zh-CN + /// + [JsonPropertyName("lang")] + public string Lang { get; set; } = string.Empty; + + /// + /// 文本内容 + /// 必填:是 + /// 示例值:中文示例 + /// + [JsonPropertyName("value")] + public string Value { get; set; } = string.Empty; + } + } + + /// + /// 名 - 第二本地文字 + /// 必填:否 + /// 示例值:五 + /// + [JsonPropertyName("local_first_name_2")] + public string? LocalFirstName2 { get; set; } + + /// + /// 姓 - 第二本地文字 + /// 必填:否 + /// 示例值:王 + /// + [JsonPropertyName("local_primary_2")] + public string? LocalPrimary2 { get; set; } + + /// + /// 补充姓名类型,枚举值可查询[获取字段详情](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口获取,按如下参数查询即可: + /// - custom_api_name:additional_name_type + /// - object_api_name:person_name + /// 必填:否 + /// + [JsonPropertyName("additional_name_type")] + public Enum? AdditionalNameType { get; set; } + + /// + /// + /// 必填:否 + /// 示例值:帅 + /// + [JsonPropertyName("first_name")] + public string? FirstName { get; set; } + + /// + /// 全名 + /// 必填:否 + /// 示例值:王大帅 + /// + [JsonPropertyName("full_name")] + public string? FullName { get; set; } + + /// + /// 姓氏称谓 + /// 必填:否 + /// 示例值:王 + /// + [JsonPropertyName("hereditary")] + public string? Hereditary { get; set; } + + /// + /// 自定义姓名(未传入时,姓名将默认根据所属国家 / 地区规则对相关姓、名字段拼接) + /// 必填:否 + /// 示例值:王大帅 + /// + [JsonPropertyName("custom_name")] + public string? CustomName { get; set; } + + /// + /// 本地文字的自定义姓名(未传入时,本地文字的姓名将默认根据所属国家 / 地区规则对本地文字的相关姓、名字段拼接) + /// 必填:否 + /// 示例值:王大帅 + /// + [JsonPropertyName("custom_local_name")] + public string? CustomLocalName { get; set; } + + /// + /// 中间名 + /// 必填:否 + /// 示例值:大 + /// + [JsonPropertyName("middle_name")] + public string? MiddleName { get; set; } + + /// + /// + /// 必填:否 + /// 示例值:王 + /// + [JsonPropertyName("name_primary")] + public string? NamePrimary { get; set; } + + /// + /// 第二姓氏 + /// 必填:否 + /// 示例值:王 + /// + [JsonPropertyName("secondary")] + public string? Secondary { get; set; } + + /// + /// 尊称,枚举值可查询[获取字段详情](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口获取,按如下参数查询即可: + /// - custom_api_name:social + /// - object_api_name:person_name + /// 必填:否 + /// 示例值:王大帅 + /// + [JsonPropertyName("social")] + public Enum? Social { get; set; } + + /// + /// 婚后姓氏 + /// 必填:否 + /// 示例值:王 + /// + [JsonPropertyName("tertiary")] + public string? Tertiary { get; set; } + + /// + /// 头衔,枚举值可查询[获取字段详情](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口获取,按如下参数查询即可: + /// - custom_api_name:title + /// - object_api_name:person_name + /// 必填:否 + /// 示例值:王 + /// + [JsonPropertyName("title")] + public Enum? Title { get; set; } + + /// + /// 本地中间名 + /// 必填:否 + /// 示例值:大 + /// + [JsonPropertyName("local_middle_name")] + public string? LocalMiddleName { get; set; } + + /// + /// 第二姓氏 - 本地文字 + /// 必填:否 + /// 示例值:王 + /// + [JsonPropertyName("local_secondary")] + public string? LocalSecondary { get; set; } + + /// + /// 展示姓名(本地和西方文字) + /// 必填:否 + /// 示例值:王大帅 + /// + [JsonPropertyName("display_name_local_and_western_script")] + public string? DisplayNameLocalAndWesternScript { get; set; } + + /// + /// 展示姓名(本地文字) + /// 必填:否 + /// 示例值:王大帅 + /// + [JsonPropertyName("display_name_local_script")] + public string? DisplayNameLocalScript { get; set; } + + /// + /// 展示姓名(西方文字) + /// 必填:否 + /// 示例值:王大帅 + /// + [JsonPropertyName("display_name_western_script")] + public string? DisplayNameWesternScript { get; set; } + } + + /// + /// 关系 + /// 必填:否 + /// + [JsonPropertyName("relationship")] + public Enum? Relationship { get; set; } + + /// + /// 关系 + /// + public record Enum + { + /// + /// 枚举值 + /// 必填:是 + /// 示例值:phone_type + /// + [JsonPropertyName("enum_name")] + public string EnumName { get; set; } = string.Empty; + + /// + /// 枚举多语展示 + /// 必填:否 + /// + [JsonPropertyName("display")] + public I18n[]? Displies { get; set; } + + /// + /// 枚举多语展示 + /// + public record I18n + { + /// + /// 语言编码(IETF BCP 47) + /// 必填:是 + /// 示例值:zh-CN + /// + [JsonPropertyName("lang")] + public string Lang { get; set; } = string.Empty; + + /// + /// 文本内容 + /// 必填:是 + /// 示例值:中文示例 + /// + [JsonPropertyName("value")] + public string Value { get; set; } = string.Empty; + } + } + + /// + /// 电话 + /// 必填:否 + /// + [JsonPropertyName("phone_ist")] + public Phone[]? PhoneIsts { get; set; } + + /// + /// 电话 + /// + public record Phone + { + /// + /// 国家区号,枚举值可通过文档[枚举常量介绍](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/feishu-people-enum-constant)手机区号(international_area_code)枚举定义获得 + /// 必填:否 + /// + [JsonPropertyName("international_area_code")] + public Enum? InternationalAreaCode { get; set; } + + /// + /// 国家区号,枚举值可通过文档[枚举常量介绍](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/feishu-people-enum-constant)手机区号(international_area_code)枚举定义获得 + /// + public record Enum + { + /// + /// 枚举值 + /// 必填:是 + /// 示例值:phone_type + /// + [JsonPropertyName("enum_name")] + public string EnumName { get; set; } = string.Empty; + + /// + /// 枚举多语展示 + /// 必填:否 + /// + [JsonPropertyName("display")] + public I18n[]? Displies { get; set; } + + /// + /// 枚举多语展示 + /// + public record I18n + { + /// + /// 语言编码(IETF BCP 47) + /// 必填:是 + /// 示例值:zh-CN + /// + [JsonPropertyName("lang")] + public string Lang { get; set; } = string.Empty; + + /// + /// 文本内容 + /// 必填:是 + /// 示例值:中文示例 + /// + [JsonPropertyName("value")] + public string Value { get; set; } = string.Empty; + } + } + + /// + /// 电话号码 + /// 必填:是 + /// 示例值:010-12345678 + /// + [JsonPropertyName("phone_number")] + public string PhoneNumber { get; set; } = string.Empty; + + /// + /// 完整电话号码 + /// 必填:否 + /// 示例值:+86 010-12345678 + /// + [JsonPropertyName("formatted_phone_number")] + public string? FormattedPhoneNumber { get; set; } + + /// + /// 设备类型 + /// 必填:否 + /// + [JsonPropertyName("device_type")] + public Enum? DeviceType { get; set; } + + /// + /// 电话用途 + /// 必填:否 + /// + [JsonPropertyName("phone_usage")] + public Enum? PhoneUsage { get; set; } + + /// + /// 主要电话 + /// 必填:否 + /// 示例值:true + /// + [JsonPropertyName("is_primary")] + public bool? IsPrimary { get; set; } + + /// + /// 公开电话 + /// 必填:否 + /// 示例值:true + /// + [JsonPropertyName("is_public")] + public bool? IsPublic { get; set; } + } + + /// + /// 电话 + /// 必填:否 + /// + [JsonPropertyName("phone_list")] + public Phone[]? PhoneLists { get; set; } + + /// + /// 法定姓名 + /// 必填:否 + /// 示例值:张三 + /// + [JsonPropertyName("legal_name")] + public string? LegalName { get; set; } + + /// + /// 自定义字段 + /// 必填:否 + /// + [JsonPropertyName("custom_fields")] + public CustomFieldData[]? CustomFields { get; set; } + + /// + /// 自定义字段 + /// + public record CustomFieldData + { + /// + /// 自定义字段 apiname,即自定义字段的唯一标识 + /// 必填:是 + /// 示例值:name + /// + [JsonPropertyName("custom_api_name")] + public string CustomApiName { get; set; } = string.Empty; + + /// + /// 自定义字段名称 + /// 必填:否 + /// + [JsonPropertyName("name")] + public CustomName? Name { get; set; } + + /// + /// 自定义字段名称 + /// + public record CustomName + { + /// + /// 中文 + /// 必填:否 + /// 示例值:自定义姓名 + /// + [JsonPropertyName("zh_cn")] + public string? ZhCn { get; set; } + + /// + /// 英文 + /// 必填:否 + /// 示例值:Custom Name + /// + [JsonPropertyName("en_us")] + public string? EnUs { get; set; } + } + + /// + /// 自定义字段类型 + /// 值类型说明: + /// - 1:文本 Text,“文本”和“超链接”属于该类型 + /// - 2:布尔 Boolean + /// - 3:数字 Number + /// - 4:枚举 Option,“单选”和“多选”为该类型 + /// - 5:查找 Lookup,“人员(单选)”、“人员(多选)”和个人信息中的自定义分组为该类型 + /// - 6:自动编码 Autonumber + /// - 7:日期时间 Datetime + /// - 8:附件 Attachment,“附件单选”和“附件多选”为该类型 + /// - 9:图片 Image + /// - 10:计算字段 Calculated + /// - 11:反向查找 Backlookup + /// 必填:否 + /// 示例值:1 + /// + [JsonPropertyName("type")] + public int? Type { get; set; } + + /// + /// 字段值,是 json 转义后的字符串,根据元数据定义不同,字段格式不同(如 123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05") + /// 必填:是 + /// 示例值:\"231\" + /// + [JsonPropertyName("value")] + public string Value { get; set; } = string.Empty; + } + } + + /// + /// 参加工作日期 + /// 必填:否 + /// 示例值:2020-10-01 + /// + [JsonPropertyName("date_entered_workforce")] + public string? DateEnteredWorkforce { get; set; } + + /// + /// 工龄 + /// 必填:否 + /// 示例值:2 + /// + [JsonPropertyName("working_years")] + public int? WorkingYears { get; set; } + + /// + /// 头像资源的 ID + /// 必填:否 + /// 示例值:dfysuc8x76dsfsw + /// + [JsonPropertyName("profile_image_id")] + public string? ProfileImageId { get; set; } + + /// + /// 邮箱地址 + /// 必填:否 + /// 示例值:test@163.com + /// + [JsonPropertyName("email_address")] + public string? EmailAddress { get; set; } + + /// + /// 年龄 + /// 必填:否 + /// 示例值:22 + /// + [JsonPropertyName("age")] + public int? Age { get; set; } + + /// + /// 最高学历教育经历 + /// 必填:否 + /// + [JsonPropertyName("highest_level_of_education")] + public Education? HighestLevelOfEducation { get; set; } + + /// + /// 最高学位教育经历 + /// 必填:否 + /// + [JsonPropertyName("highest_degree_of_education")] + public Education? HighestDegreeOfEducation { get; set; } + + /// + /// 个人资料附件 + /// 必填:否 + /// + [JsonPropertyName("personal_profile")] + public PersonalProfile[]? PersonalProfiles { get; set; } + + /// + /// 个人资料附件 + /// + public record PersonalProfile + { + /// + /// 资料类型,枚举值可查询[获取字段详情](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口获取,按如下参数查询即可: + /// - custom_api_name:profile_type + /// - object_api_name:personal_profile + /// 必填:否 + /// + [JsonPropertyName("personal_profile_type")] + public Enum? PersonalProfileType { get; set; } + + /// + /// 资料类型,枚举值可查询[获取字段详情](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口获取,按如下参数查询即可: + /// - custom_api_name:profile_type + /// - object_api_name:personal_profile + /// + public record Enum + { + /// + /// 枚举值 + /// 必填:是 + /// 示例值:phone_type + /// + [JsonPropertyName("enum_name")] + public string EnumName { get; set; } = string.Empty; + + /// + /// 枚举多语展示 + /// 必填:否 + /// + [JsonPropertyName("display")] + public I18n[]? Displies { get; set; } + + /// + /// 枚举多语展示 + /// + public record I18n + { + /// + /// 语言编码(IETF BCP 47) + /// 必填:是 + /// 示例值:zh-CN + /// + [JsonPropertyName("lang")] + public string Lang { get; set; } = string.Empty; + + /// + /// 文本内容 + /// 必填:是 + /// 示例值:中文示例 + /// + [JsonPropertyName("value")] + public string Value { get; set; } = string.Empty; + } + } + + /// + /// 文件列表 + /// 必填:否 + /// + [JsonPropertyName("files")] + public File[]? Files { get; set; } + + /// + /// 文件列表 + /// + public record File + { + /// + /// 文件ID,文件内容可通过[下载文件](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/file/get)接口获取 + /// 必填:否 + /// 示例值:150018109586e8ea745e47ae8feb3722dbe1d03a181336393633393133303431393831343930373235150200 + /// + [JsonPropertyName("id")] + public string? Id { get; set; } + + /// + /// 文件名 + /// 必填:否 + /// 示例值:document.txt + /// + [JsonPropertyName("name")] + public string? Name { get; set; } + } + } + + /// + /// 人才 ID + /// 必填:否 + /// 示例值:6863326262618752123 + /// + [JsonPropertyName("talent_id")] + public string? TalentId { get; set; } + + /// + /// 自定义字段 + /// 必填:否 + /// + [JsonPropertyName("custom_fields")] + public CustomFieldData[]? CustomFields { get; set; } + + /// + /// 自定义字段 + /// + public record CustomFieldData + { + /// + /// 自定义字段 apiname,即自定义字段的唯一标识 + /// 必填:是 + /// 示例值:name + /// + [JsonPropertyName("custom_api_name")] + public string CustomApiName { get; set; } = string.Empty; + + /// + /// 自定义字段名称 + /// 必填:否 + /// + [JsonPropertyName("name")] + public CustomName? Name { get; set; } + + /// + /// 自定义字段名称 + /// + public record CustomName + { + /// + /// 中文 + /// 必填:否 + /// 示例值:自定义姓名 + /// + [JsonPropertyName("zh_cn")] + public string? ZhCn { get; set; } + + /// + /// 英文 + /// 必填:否 + /// 示例值:Custom Name + /// + [JsonPropertyName("en_us")] + public string? EnUs { get; set; } + } + + /// + /// 自定义字段类型 + /// 值类型说明: + /// - 1:文本 Text,“文本”和“超链接”属于该类型 + /// - 2:布尔 Boolean + /// - 3:数字 Number + /// - 4:枚举 Option,“单选”和“多选”为该类型 + /// - 5:查找 Lookup,“人员(单选)”、“人员(多选)”和个人信息中的自定义分组为该类型 + /// - 6:自动编码 Autonumber + /// - 7:日期时间 Datetime + /// - 8:附件 Attachment,“附件单选”和“附件多选”为该类型 + /// - 9:图片 Image + /// - 10:计算字段 Calculated + /// - 11:反向查找 Backlookup + /// 必填:否 + /// 示例值:1 + /// + [JsonPropertyName("type")] + public int? Type { get; set; } + + /// + /// 字段值,是 json 转义后的字符串,根据元数据定义不同,字段格式不同(如 123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05") + /// 必填:是 + /// 示例值:\"231\" + /// + [JsonPropertyName("value")] + public string Value { get; set; } = string.Empty; + } + + /// + /// 居民身份证件号码 + /// 必填:否 + /// 示例值:11010000000000 + /// + [JsonPropertyName("national_id_number")] + public string? NationalIdNumber { get; set; } + + /// + /// 家庭地址 + /// 必填:否 + /// 示例值:6863326262618752123 + /// + [JsonPropertyName("family_address")] + public string? FamilyAddress { get; set; } + + /// + /// 个人附加信息 + /// 必填:否 + /// 示例值:6863326262618752123 + /// + [JsonPropertyName("person_info_chns")] + public PersonInfoChn[]? PersonInfoChns { get; set; } + + /// + /// 个人附加信息 + /// + public record PersonInfoChn + { + /// + /// 籍贯 ID,可以通过[查询省份/行政区信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region_subdivision/search)接口获取详情 + /// 必填:否 + /// 示例值:6863326262618752111 + /// + [JsonPropertyName("native_region")] + public string? NativeRegion { get; set; } + + /// + /// 户口类型,枚举值可通过文档[枚举常量介绍](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/feishu-people-enum-constant)户口类型(hukou_type)枚举定义获得 + /// 必填:否 + /// + [JsonPropertyName("hukou_type")] + public Enum? HukouType { get; set; } + + /// + /// 户口类型,枚举值可通过文档[枚举常量介绍](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/feishu-people-enum-constant)户口类型(hukou_type)枚举定义获得 + /// + public record Enum + { + /// + /// 枚举值 + /// 必填:是 + /// 示例值:phone_type + /// + [JsonPropertyName("enum_name")] + public string EnumName { get; set; } = string.Empty; + + /// + /// 枚举多语展示 + /// 必填:否 + /// + [JsonPropertyName("display")] + public I18n[]? Displies { get; set; } + + /// + /// 枚举多语展示 + /// + public record I18n + { + /// + /// 语言编码(IETF BCP 47) + /// 必填:是 + /// 示例值:zh-CN + /// + [JsonPropertyName("lang")] + public string Lang { get; set; } = string.Empty; + + /// + /// 文本内容 + /// 必填:是 + /// 示例值:中文示例 + /// + [JsonPropertyName("value")] + public string Value { get; set; } = string.Empty; + } + } + + /// + /// 户口所在地 + /// 必填:否 + /// 示例值:山东省平阴县 + /// + [JsonPropertyName("hukou_location")] + public string? HukouLocation { get; set; } + + /// + /// 政治面貌,枚举值可通过文档[枚举常量介绍](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/feishu-people-enum-constant)政治面貌(political_affiliation)枚举定义获得 + /// 必填:否 + /// + [JsonPropertyName("political_affiliations")] + public Enum[]? PoliticalAffiliations { get; set; } + } + + /// + /// 出生国家/地区,可以通过接口[查询国家/地区信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region/search)获取详情 + /// 必填:否 + /// 示例值:中国 + /// + [JsonPropertyName("born_country_region")] + public string? BornCountryRegion { get; set; } + + /// + /// 是否残疾 + /// 必填:否 + /// 示例值:true + /// + [JsonPropertyName("is_disabled")] + public bool? IsDisabled { get; set; } + + /// + /// 残疾证号 + /// 必填:否 + /// 示例值:1110000 + /// + [JsonPropertyName("disable_card_number")] + public string? DisableCardNumber { get; set; } + + /// + /// 是否烈属 + /// 必填:否 + /// 示例值:true + /// + [JsonPropertyName("is_martyr_family")] + public bool? IsMartyrFamily { get; set; } + + /// + /// 烈属证号 + /// 必填:否 + /// 示例值:1110000 + /// + [JsonPropertyName("martyr_card_number")] + public string? MartyrCardNumber { get; set; } + + /// + /// 是否孤老 + /// 必填:否 + /// 示例值:true + /// + [JsonPropertyName("is_old_alone")] + public bool? IsOldAlone { get; set; } + + /// + /// 居民身份信息 + /// 必填:否 + /// 示例值:6863326262618752123 + /// + [JsonPropertyName("resident_taxes")] + public ResidentTax[]? ResidentTaxes { get; set; } + + /// + /// 居民身份信息 + /// + public record ResidentTax + { + /// + /// 年度 + /// 必填:是 + /// 示例值:2023 + /// + [JsonPropertyName("year_resident_tax")] + public string YearResidentTax { get; set; } = string.Empty; + + /// + /// resident_status + /// 居民身份,枚举值可查询[获取字段详情](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口获取,按如下参数查询即可: + /// - custom_api_name:resident_status + /// - object_api_name:resident_tax + /// 必填:否 + /// + [JsonPropertyName("resident_status")] + public Enum? ResidentStatus { get; set; } + + /// + /// resident_status + /// 居民身份,枚举值可查询[获取字段详情](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口获取,按如下参数查询即可: + /// - custom_api_name:resident_status + /// - object_api_name:resident_tax + /// + public record Enum + { + /// + /// 枚举值 + /// 必填:是 + /// 示例值:phone_type + /// + [JsonPropertyName("enum_name")] + public string EnumName { get; set; } = string.Empty; + + /// + /// 枚举多语展示 + /// 必填:否 + /// + [JsonPropertyName("display")] + public I18n[]? Displies { get; set; } + + /// + /// 枚举多语展示 + /// + public record I18n + { + /// + /// 语言编码(IETF BCP 47) + /// 必填:是 + /// 示例值:zh-CN + /// + [JsonPropertyName("lang")] + public string Lang { get; set; } = string.Empty; + + /// + /// 文本内容 + /// 必填:是 + /// 示例值:中文示例 + /// + [JsonPropertyName("value")] + public string Value { get; set; } = string.Empty; + } + } + + /// + /// 国家/地区,可以通过接口[查询国家/地区信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region/search)获取详情 + /// 必填:否 + /// 示例值:中国 + /// + [JsonPropertyName("tax_country_region_id")] + public string? TaxCountryRegionId { get; set; } + + /// + /// 自定义字段 + /// 必填:否 + /// + [JsonPropertyName("custom_fields")] + public ObjectFieldData[]? CustomFields { get; set; } + + /// + /// 自定义字段 + /// + public record ObjectFieldData + { + /// + /// 字段名 + /// 必填:是 + /// 示例值:name + /// + [JsonPropertyName("field_name")] + public string FieldName { get; set; } = string.Empty; + + /// + /// 字段值,是json转义后的字符串,根据元数据定义不同,字段格式不同(123, 123.23, true, [\"id1\",\"id2\], 2006-01-02 15:04:05]) + /// 必填:是 + /// 示例值:Sandy + /// + [JsonPropertyName("value")] + public string Value { get; set; } = string.Empty; + } + } + + /// + /// 宗教信仰,枚举值可查询[获取字段详情](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口获取,按如下参数查询即可: + /// - custom_api_name:religion + /// - object_api_name:person + /// 必填:否 + /// + [JsonPropertyName("religion")] + public Enum? Religion { get; set; } + + /// + /// 工龄 (单位:年)浮点类型 + /// 必填:否 + /// 示例值:2.1 + /// + [JsonPropertyName("working_years_v2")] + public float? WorkingYearsV2 { get; set; } + + /// + /// 个人信息 创建时间,时间格式为 2023-09-01 13:21:12 + /// 必填:否 + /// 示例值:2023-09-01 13:21:12 + /// + [JsonPropertyName("created_at")] + public string? CreatedAt { get; set; } + + /// + /// 个人信息 更新时间,时间格式为 2023-09-01 13:21:12 + /// 必填:否 + /// 示例值:2022-01-02 + /// + [JsonPropertyName("updated_at")] + public string? UpdatedAt { get; set; } + + /// + /// 个人信息 创建人,可以通过[批量查询员工信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)接口获取详情,user_id_type使用people_corehr_id类型 + /// 必填:否 + /// 示例值:69928404442626824 + /// + [JsonPropertyName("created_by")] + public string? CreatedBy { get; set; } + + /// + /// 个人信息 更新人,可以通过[批量查询员工信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)接口获取详情,user_id_type使用people_corehr_id类型 + /// 必填:否 + /// 示例值:69928404442626824 + /// + [JsonPropertyName("updated_by")] + public string? UpdatedBy { get; set; } + + /// + /// 银行卡号 + /// 必填:否 + /// 示例值:69928404442626824 + /// + [JsonPropertyName("bank_account_number")] + public string? BankAccountNumber { get; set; } + + /// + /// 护照号码 + /// 必填:否 + /// 示例值:6919733936050406926 + /// + [JsonPropertyName("passport_number")] + public string? PassportNumber { get; set; } + + /// + /// 上家公司 + /// 必填:否 + /// + [JsonPropertyName("former_employer")] + public I18n[]? FormerEmployers { get; set; } + + /// + /// 上家公司 + /// + public record I18n + { + /// + /// 语言编码(IETF BCP 47) + /// 必填:是 + /// 示例值:zh-CN + /// + [JsonPropertyName("lang")] + public string Lang { get; set; } = string.Empty; + + /// + /// 文本内容 + /// 必填:是 + /// 示例值:中文示例 + /// + [JsonPropertyName("value")] + public string Value { get; set; } = string.Empty; + } + } + + /// + /// 工作信息 + /// 必填:否 + /// + [JsonPropertyName("employment_info")] + public PreHireEmploymentInfo? EmploymentInfo { get; set; } + + /// + /// 工作信息 + /// + public record PreHireEmploymentInfo + { + /// + /// 部门 ID ,可以通过[搜索部门信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/department/search)接口获取详情,department_id_type使用people_corehr_department_id类型 + /// 必填:否 + /// 示例值:7147562782945478177 + /// + [JsonPropertyName("department_id")] + public string? DepartmentId { get; set; } + + /// + /// 成本中心分摊信息 + /// 必填:否 + /// + [JsonPropertyName("cost_center_rates")] + public JobDataCostCenter[]? CostCenterRates { get; set; } + + /// + /// 成本中心分摊信息 + /// + public record JobDataCostCenter + { + /// + /// 成本中心 ID,可以通过[搜索成本中心信息](https://open.feishu.cn/document/server-docs/corehr-v1/organization-management/cost_center/search)接口获取对应的成本中心信息 + /// 必填:否 + /// 示例值:6950635856373745165 + /// + [JsonPropertyName("cost_center_id")] + public string? CostCenterId { get; set; } + + /// + /// 分摊比例 + /// 必填:否 + /// 示例值:100 + /// + [JsonPropertyName("rate")] + public int? Rate { get; set; } + } + + /// + /// 办公地点 ID,详细信息可通过[查询地点](https://open.feishu.cn/document/server-docs/corehr-v1/organization-management/location/get)接口获得 + /// 必填:否 + /// 示例值:6977976687350924832 + /// + [JsonPropertyName("office_location_id")] + public string? OfficeLocationId { get; set; } + + /// + /// 工作地点id ,可通过[批量查询地点](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/location/list)接口获取详情 + /// 必填:否 + /// 示例值:6977976687350924832 + /// + [JsonPropertyName("work_location_id")] + public string? WorkLocationId { get; set; } + + /// + /// 工位 + /// 必填:否 + /// 示例值:ABC123 + /// + [JsonPropertyName("work_station")] + public string? WorkStation { get; set; } + + /// + /// 工号 + /// 必填:否 + /// 示例值:1234567 + /// + [JsonPropertyName("worker_id")] + public string? WorkerId { get; set; } + + /// + /// 薪资类型,枚举值可查询[获取字段详情](https://open.feishu.cn/document/server-docs/corehr-v1/basic-infomation/custom_field/get_by_param)接口获取,按如下参数查询即可: + /// - custom_api_name:compensation_type + /// - object_api_name:pre_hire + /// 必填:否 + /// + [JsonPropertyName("compensation_type")] + public Enum? CompensationType { get; set; } + + /// + /// 薪资类型,枚举值可查询[获取字段详情](https://open.feishu.cn/document/server-docs/corehr-v1/basic-infomation/custom_field/get_by_param)接口获取,按如下参数查询即可: + /// - custom_api_name:compensation_type + /// - object_api_name:pre_hire + /// + public record Enum + { + /// + /// 枚举值 + /// 必填:是 + /// 示例值:phone_type + /// + [JsonPropertyName("enum_name")] + public string EnumName { get; set; } = string.Empty; + + /// + /// 枚举多语展示 + /// 必填:否 + /// + [JsonPropertyName("display")] + public I18n[]? Displies { get; set; } + + /// + /// 枚举多语展示 + /// + public record I18n + { + /// + /// 语言编码(IETF BCP 47) + /// 必填:是 + /// 示例值:zh-CN + /// + [JsonPropertyName("lang")] + public string Lang { get; set; } = string.Empty; + + /// + /// 文本内容 + /// 必填:是 + /// 示例值:中文示例 + /// + [JsonPropertyName("value")] + public string Value { get; set; } = string.Empty; + } + } + + /// + /// 直属上级雇佣 ID,可以通过[搜索员工信息](https://open.feishu.cn/document/server-docs/corehr-v1/employee/search)接口获取详情,user_id_type使用people_corehr_id类型 + /// 必填:否 + /// 示例值:7032210902531327521 + /// + [JsonPropertyName("direct_leader_id")] + public string? DirectLeaderId { get; set; } + + /// + /// 职务 ID ,可以通过[查询职务](https://open.feishu.cn/document/server-docs/corehr-v1/job-management/job/get)接口获取详情 + /// 必填:否 + /// 示例值:6977976735715378724 + /// + [JsonPropertyName("job_id")] + public string? JobId { get; set; } + + /// + /// 序列 ID,可以通过[查询序列](https://open.feishu.cn/document/server-docs/corehr-v1/job-management/job_family/get)接口获取详情 + /// 必填:否 + /// 示例值:6977972856625939999 + /// + [JsonPropertyName("job_family_id")] + public string? JobFamilyId { get; set; } + + /// + /// 职级 ID,可以通过[查询职级](https://open.feishu.cn/document/server-docs/corehr-v1/job-management/job_level/get)接口获取详情 + /// 必填:否 + /// 示例值:6977971894960145950 + /// + [JsonPropertyName("job_level_id")] + public string? JobLevelId { get; set; } + + /// + /// 职等 ID + /// 必填:否 + /// 示例值:6977971894960145950 + /// + [JsonPropertyName("job_grade_id")] + public string? JobGradeId { get; set; } + + /// + /// 职务头衔 + /// 必填:否 + /// 示例值:java + /// + [JsonPropertyName("job_title")] + public string? JobTitle { get; set; } + + /// + /// 人员类型 ID ,可以通过招聘[查询人员类型](https://open.feishu.cn/document/server-docs/corehr-v1/basic-infomation/employee_type/get)接口获取详情 + /// 必填:否 + /// 示例值:6977973225846343171 + /// + [JsonPropertyName("employee_type_id")] + public string? EmployeeTypeId { get; set; } + + /// + /// 雇佣类型, 枚举值可查询[获取字段详情](https://open.feishu.cn/document/server-docs/corehr-v1/basic-infomation/custom_field/get_by_param)接口获取,按如下参数查询即可: + /// - object_api_name = pre_hire + /// - custom_api_name = employment_type + /// 必填:否 + /// 示例值:employee + /// + [JsonPropertyName("employment_type")] + public string? EmploymentType { get; set; } + + /// + /// 工作邮箱 + /// 必填:否 + /// 示例值:joshua@bytedance.com + /// + [JsonPropertyName("work_email")] + public string? WorkEmail { get; set; } + + /// + /// 公司 ID , 详细信息可通过[查询单个公司](https://open.feishu.cn/document/server-docs/corehr-v1/organization-management/company/get)接口获得 + /// 必填:否 + /// 示例值:6738317738688661772 + /// + [JsonPropertyName("company_id")] + public string? CompanyId { get; set; } + + /// + /// 社保城市 ID ,详细信息可通过[查询地点](https://open.feishu.cn/document/server-docs/corehr-v1/organization-management/location/get)接口获得 + /// 必填:否 + /// 示例值:6977973225846343171 + /// + [JsonPropertyName("social_security_city_id")] + public string? SocialSecurityCityId { get; set; } + + /// + /// 是否包含竞业条款 + /// 必填:否 + /// 示例值:true + /// + [JsonPropertyName("non_compete_covenant")] + public bool? NonCompeteCovenant { get; set; } + + /// + /// 周工作时长(单位:小时) + /// 必填:否 + /// 示例值:8 + /// + [JsonPropertyName("weekly_working_hours")] + public int? WeeklyWorkingHours { get; set; } + + /// + /// 是否离职重聘 + /// 必填:否 + /// 示例值:no + /// 可选值: + /// to_be_confirmed:待确认,系统会判断该员工是否存在历史雇佣记录,如果存在且需要二次确认时会调用失败,并返回历史雇佣记录 + /// no:否,系统直接标为非离职重聘人员,不再做重复判断 + /// yes:是,要求历史雇佣信息 ID 必填 + /// + /// + [JsonPropertyName("rehire")] + public string? Rehire { get; set; } + + /// + /// 历史雇佣信息 ID ,雇佣信息详细信息可以通过[查询单个雇佣信息](https://open.feishu.cn/document/server-docs/corehr-v1/employee/employment/get) 获得,系统会检验当前雇佣信息的合法性,要求: + /// - 雇佣信息为该人员最后一次雇佣记录 + /// - 雇佣信息的雇员状态 = "terminated" + /// - 该人员不存在其他待入职记录 + /// 必填:否 + /// 示例值:6977973225846343172 + /// + [JsonPropertyName("rehire_employment_id")] + public string? RehireEmploymentId { get; set; } + + /// + /// 工时制度 ID ,可通过[查询单个工时制度](https://open.feishu.cn/document/server-docs/corehr-v1/basic-infomation/working_hours_type/get)接口获取详情 + /// 必填:否 + /// 示例值:6977973225846343171 + /// + [JsonPropertyName("working_hours_type")] + public string? WorkingHoursType { get; set; } + + /// + /// 周工作时长v2(单位:小时)浮点类型 + /// 必填:否 + /// 示例值:8.5 + /// + [JsonPropertyName("weekly_working_hours_v2")] + public float? WeeklyWorkingHoursV2 { get; set; } + + /// + /// 办公地址 + /// 必填:否 + /// + [JsonPropertyName("office_address")] + public Address? OfficeAddress { get; set; } + + /// + /// 办公地址 + /// + public record Address + { + /// + /// 完整地址(本地文字) + /// 必填:否 + /// 示例值:中国北京北京 + /// + [JsonPropertyName("full_address_local_script")] + public string? FullAddressLocalScript { get; set; } + + /// + /// 完整地址(西方文字) + /// 必填:否 + /// 示例值:Beijing, Beijing, China, + /// + [JsonPropertyName("full_address_western_script")] + public string? FullAddressWesternScript { get; set; } + + /// + /// 地址 ID + /// 必填:否 + /// 示例值:6989822217869624863 + /// + [JsonPropertyName("address_id")] + public string? AddressId { get; set; } + + /// + /// 国家 / 地区,可以通过接口[查询国家/地区信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region/search)获取详情 + /// 必填:是 + /// 示例值:6862995757234914824 + /// + [JsonPropertyName("country_region_id")] + public string CountryRegionId { get; set; } = string.Empty; + + /// + /// 主要行政区ID 可以通过[查询省份/行政区信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region_subdivision/search)接口获取详情 + /// 必填:否 + /// 示例值:6863326815667095047 + /// + [JsonPropertyName("region_id")] + public string? RegionId { get; set; } + + /// + /// 地址行 1 + /// 必填:否 + /// 示例值:丹佛测试地址-纽埃时区 + /// + [JsonPropertyName("address_line1")] + public string? AddressLine1 { get; set; } + + /// + /// 地址行 2 + /// 必填:否 + /// 示例值:PoewH + /// + [JsonPropertyName("address_line2")] + public string? AddressLine2 { get; set; } + + /// + /// 地址行 3 + /// 必填:否 + /// 示例值:PoewH + /// + [JsonPropertyName("address_line3")] + public string? AddressLine3 { get; set; } + + /// + /// 地址行 4 + /// 必填:否 + /// 示例值:jmwJc + /// + [JsonPropertyName("address_line4")] + public string? AddressLine4 { get; set; } + + /// + /// 地址行 5 + /// 必填:否 + /// 示例值:jmwJc + /// + [JsonPropertyName("address_line5")] + public string? AddressLine5 { get; set; } + + /// + /// 地址行 6 + /// 必填:否 + /// 示例值:jmwJc + /// + [JsonPropertyName("address_line6")] + public string? AddressLine6 { get; set; } + + /// + /// 地址行 7 + /// 必填:否 + /// 示例值:jmwJc + /// + [JsonPropertyName("address_line7")] + public string? AddressLine7 { get; set; } + + /// + /// 地址行 8 + /// 必填:否 + /// 示例值:rafSu + /// + [JsonPropertyName("address_line8")] + public string? AddressLine8 { get; set; } + + /// + /// 地址行 9 + /// 必填:否 + /// 示例值:McPRG + /// + [JsonPropertyName("address_line9")] + public string? AddressLine9 { get; set; } + + /// + /// 地址行 1(非拉丁语系的本地文字) + /// 必填:否 + /// 示例值:丹佛测试地址-纽埃时区 + /// + [JsonPropertyName("local_address_line1")] + public string? LocalAddressLine1 { get; set; } + + /// + /// 地址行 2(非拉丁语系的本地文字) + /// 必填:否 + /// 示例值:PoewH + /// + [JsonPropertyName("local_address_line2")] + public string? LocalAddressLine2 { get; set; } + + /// + /// 地址行 3(非拉丁语系的本地文字) + /// 必填:否 + /// 示例值:PoewH + /// + [JsonPropertyName("local_address_line3")] + public string? LocalAddressLine3 { get; set; } + + /// + /// 地址行 4(非拉丁语系的本地文字) + /// 必填:否 + /// 示例值:jmwJc + /// + [JsonPropertyName("local_address_line4")] + public string? LocalAddressLine4 { get; set; } + + /// + /// 地址行 5(非拉丁语系的本地文字) + /// 必填:否 + /// 示例值:jmwJc + /// + [JsonPropertyName("local_address_line5")] + public string? LocalAddressLine5 { get; set; } + + /// + /// 地址行 6(非拉丁语系的本地文字) + /// 必填:否 + /// 示例值:jmwJc + /// + [JsonPropertyName("local_address_line6")] + public string? LocalAddressLine6 { get; set; } + + /// + /// 地址行 7(非拉丁语系的本地文字) + /// 必填:否 + /// 示例值:jmwJc + /// + [JsonPropertyName("local_address_line7")] + public string? LocalAddressLine7 { get; set; } + + /// + /// 地址行 8(非拉丁语系的本地文字) + /// 必填:否 + /// 示例值:rafSu + /// + [JsonPropertyName("local_address_line8")] + public string? LocalAddressLine8 { get; set; } + + /// + /// 地址行 9(非拉丁语系的本地文字) + /// 必填:否 + /// 示例值:McPRG + /// + [JsonPropertyName("local_address_line9")] + public string? LocalAddressLine9 { get; set; } + + /// + /// 邮政编码 + /// 必填:否 + /// 示例值:611530 + /// + [JsonPropertyName("postal_code")] + public string? PostalCode { get; set; } + + /// + /// 地址类型,枚举值可通过文档[枚举常量介绍](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/feishu-people-enum-constant)地址类型(address_type)枚举定义获得 + /// 必填:是 + /// + [JsonPropertyName("address_type_list")] + public Enum[] AddressTypeLists { get; set; } = Array.Empty(); + + /// + /// 地址类型,枚举值可通过文档[枚举常量介绍](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/feishu-people-enum-constant)地址类型(address_type)枚举定义获得 + /// + public record Enum + { + /// + /// 枚举值 + /// 必填:是 + /// 示例值:phone_type + /// + [JsonPropertyName("enum_name")] + public string EnumName { get; set; } = string.Empty; + + /// + /// 枚举多语展示 + /// 必填:否 + /// + [JsonPropertyName("display")] + public I18n[]? Displies { get; set; } + + /// + /// 枚举多语展示 + /// + public record I18n + { + /// + /// 语言编码(IETF BCP 47) + /// 必填:是 + /// 示例值:zh-CN + /// + [JsonPropertyName("lang")] + public string Lang { get; set; } = string.Empty; + + /// + /// 文本内容 + /// 必填:是 + /// 示例值:中文示例 + /// + [JsonPropertyName("value")] + public string Value { get; set; } = string.Empty; + } + } + + /// + /// 主要地址 + /// 必填:是 + /// 示例值:true + /// + [JsonPropertyName("is_primary")] + public bool IsPrimary { get; set; } + + /// + /// 公开地址 + /// 必填:是 + /// 示例值:true + /// + [JsonPropertyName("is_public")] + public bool IsPublic { get; set; } + + /// + /// 自定义字段 + /// 必填:否 + /// + [JsonPropertyName("custom_fields")] + public CustomFieldData[]? CustomFields { get; set; } + + /// + /// 自定义字段 + /// + public record CustomFieldData + { + /// + /// 自定义字段 apiname,即自定义字段的唯一标识 + /// 必填:是 + /// 示例值:name + /// + [JsonPropertyName("custom_api_name")] + public string CustomApiName { get; set; } = string.Empty; + + /// + /// 自定义字段名称 + /// 必填:否 + /// + [JsonPropertyName("name")] + public CustomName? Name { get; set; } + + /// + /// 自定义字段名称 + /// + public record CustomName + { + /// + /// 中文 + /// 必填:否 + /// 示例值:自定义姓名 + /// + [JsonPropertyName("zh_cn")] + public string? ZhCn { get; set; } + + /// + /// 英文 + /// 必填:否 + /// 示例值:Custom Name + /// + [JsonPropertyName("en_us")] + public string? EnUs { get; set; } + } + + /// + /// 自定义字段类型 + /// 值类型说明: + /// - 1:文本 Text,“文本”和“超链接”属于该类型 + /// - 2:布尔 Boolean + /// - 3:数字 Number + /// - 4:枚举 Option,“单选”和“多选”为该类型 + /// - 5:查找 Lookup,“人员(单选)”、“人员(多选)”和个人信息中的自定义分组为该类型 + /// - 6:自动编码 Autonumber + /// - 7:日期时间 Datetime + /// - 8:附件 Attachment,“附件单选”和“附件多选”为该类型 + /// - 9:图片 Image + /// - 10:计算字段 Calculated + /// - 11:反向查找 Backlookup + /// 必填:否 + /// 示例值:1 + /// + [JsonPropertyName("type")] + public int? Type { get; set; } + + /// + /// 字段值,是 json 转义后的字符串,根据元数据定义不同,字段格式不同(如 123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05") + /// 必填:是 + /// 示例值:\"231\" + /// + [JsonPropertyName("value")] + public string Value { get; set; } = string.Empty; + } + } + + /// + /// 工作日历ID,可以通过[查询工作日历](https://open.larkoffice.com/document/server-docs/calendar-v4/calendar/get)接口获取详情 + /// 必填:否 + /// 示例值:6977973225846343173 + /// + [JsonPropertyName("working_calendar_id")] + public string? WorkingCalendarId { get; set; } + + /// + /// 更新时间,时间格式为 2023-09-01 13:21:12 + /// 必填:否 + /// 示例值:2023-09-01 13:21:12 + /// + [JsonPropertyName("updated_at")] + public string? UpdatedAt { get; set; } + + /// + /// 是否疑似重聘 + /// 必填:否 + /// 示例值:false + /// + [JsonPropertyName("suspected_rehiring")] + public bool? SuspectedRehiring { get; set; } + + /// + /// 自定义字段 + /// 必填:否 + /// + [JsonPropertyName("custom_fields")] + public CustomFieldData[]? CustomFields { get; set; } + + /// + /// 自定义字段 + /// + public record CustomFieldData + { + /// + /// 自定义字段 apiname,即自定义字段的唯一标识 + /// 必填:是 + /// 示例值:name + /// + [JsonPropertyName("custom_api_name")] + public string CustomApiName { get; set; } = string.Empty; + + /// + /// 自定义字段名称 + /// 必填:否 + /// + [JsonPropertyName("name")] + public CustomName? Name { get; set; } + + /// + /// 自定义字段名称 + /// + public record CustomName + { + /// + /// 中文 + /// 必填:否 + /// 示例值:自定义姓名 + /// + [JsonPropertyName("zh_cn")] + public string? ZhCn { get; set; } + + /// + /// 英文 + /// 必填:否 + /// 示例值:Custom Name + /// + [JsonPropertyName("en_us")] + public string? EnUs { get; set; } + } + + /// + /// 自定义字段类型 + /// 值类型说明: + /// - 1:文本 Text,“文本”和“超链接”属于该类型 + /// - 2:布尔 Boolean + /// - 3:数字 Number + /// - 4:枚举 Option,“单选”和“多选”为该类型 + /// - 5:查找 Lookup,“人员(单选)”、“人员(多选)”和个人信息中的自定义分组为该类型 + /// - 6:自动编码 Autonumber + /// - 7:日期时间 Datetime + /// - 8:附件 Attachment,“附件单选”和“附件多选”为该类型 + /// - 9:图片 Image + /// - 10:计算字段 Calculated + /// - 11:反向查找 Backlookup + /// 必填:否 + /// 示例值:1 + /// + [JsonPropertyName("type")] + public int? Type { get; set; } + + /// + /// 字段值,是 json 转义后的字符串,根据元数据定义不同,字段格式不同(如 123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05") + /// 必填:是 + /// 示例值:\"231\" + /// + [JsonPropertyName("value")] + public string Value { get; set; } = string.Empty; + } + + /// + /// 岗位 ID,如需获取具体值,请联系人员档案管理员 + /// 必填:否 + /// 示例值:6977976735715373452 + /// + [JsonPropertyName("position_id")] + public string? PositionId { get; set; } + + /// + /// 公司主体是否被手动修改 + /// 必填:否 + /// 示例值:true + /// + [JsonPropertyName("company_manual_updated")] + public bool? CompanyManualUpdated { get; set; } + + /// + /// 薪资组信息 + /// 必填:否 + /// + [JsonPropertyName("pay_group")] + public PreHirePayGroupInfo? PayGroup { get; set; } + + /// + /// 薪资组信息 + /// + public record PreHirePayGroupInfo + { + /// + /// 薪资组名称 + /// 必填:否 + /// + [JsonPropertyName("name")] + public I18n[]? Names { get; set; } + + /// + /// 薪资组名称 + /// + public record I18n + { + /// + /// 语言编码(IETF BCP 47) + /// 必填:是 + /// 示例值:zh-CN + /// + [JsonPropertyName("lang")] + public string Lang { get; set; } = string.Empty; + + /// + /// 文本内容 + /// 必填:是 + /// 示例值:中文示例 + /// + [JsonPropertyName("value")] + public string Value { get; set; } = string.Empty; + } + + /// + /// 薪资组 ID + /// 必填:否 + /// 示例值:1234566 + /// + [JsonPropertyName("id")] + public string? Id { get; set; } + } + + /// + /// 是否信息异常 + /// 必填:否 + /// 示例值:true + /// + [JsonPropertyName("whether_the_information_is_abnormal")] + public bool? WhetherTheInformationIsAbnormal { get; set; } + + /// + /// 异常原因列表 + /// 必填:否 + /// + [JsonPropertyName("abnormal_reason")] + public PreHireAbnormalReason[]? AbnormalReasons { get; set; } + + /// + /// 异常原因列表 + /// + public record PreHireAbnormalReason + { + /// + /// 异常信息描述 + /// 必填:否 + /// 最大长度:100 + /// 最小长度:0 + /// + [JsonPropertyName("descriptions")] + public I18n[]? Descriptions { get; set; } + + /// + /// 异常信息描述 + /// + public record I18n + { + /// + /// 语言编码(IETF BCP 47) + /// 必填:是 + /// 示例值:zh-CN + /// + [JsonPropertyName("lang")] + public string Lang { get; set; } = string.Empty; + + /// + /// 文本内容 + /// 必填:是 + /// 示例值:中文示例 + /// + [JsonPropertyName("value")] + public string Value { get; set; } = string.Empty; + } + } + + /// + /// 是否有 Offer 薪酬 + /// 必填:否 + /// 示例值:true + /// + [JsonPropertyName("has_offer_salary")] + public bool? HasOfferSalary { get; set; } + + /// + /// 招聘项目 ID + /// 必填:否 + /// 示例值:23214213152 + /// + [JsonPropertyName("recruitment_project_id")] + public string? RecruitmentProjectId { get; set; } + + /// + /// 排班类型,枚举值可查询[获取字段详情](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口获取,按如下参数查询即可: + /// - custom_api_name:work_shift + /// - object_api_name:pre_hire + /// 必填:否 + /// + [JsonPropertyName("work_shift")] + public Enum? WorkShift { get; set; } + + /// + /// 创建时间,时间格式为 2023-09-01 13:21:12 + /// 必填:否 + /// 示例值:2023-01-10 10:29 + /// + [JsonPropertyName("created_at")] + public string? CreatedAt { get; set; } + + /// + /// 待入职信息 创建人,可以通过[批量查询员工信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)接口获取详情,user_id_type使用people_corehr_id类型 + /// 必填:否 + /// 示例值:69928404442626824 + /// + [JsonPropertyName("created_by")] + public string? CreatedBy { get; set; } + + /// + /// 待入职信息 更新人,可以通过[批量查询员工信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)接口获取详情,user_id_type使用people_corehr_id类型 + /// 必填:否 + /// 示例值:69928404442626824 + /// + [JsonPropertyName("updated_by")] + public string? UpdatedBy { get; set; } + } + + /// + /// 入职信息 + /// 必填:否 + /// + [JsonPropertyName("onboarding_info")] + public PreHireOnboardingInfo? OnboardingInfo { get; set; } + + /// + /// 入职信息 + /// + public record PreHireOnboardingInfo + { + /// + /// Offer ID,可以通过招聘[获取 Offer 列表](https://open.feishu.cn/document/server-docs/hire-v1/candidate-management/delivery-process-management/offer/list)接口获取详情 + /// 必填:否 + /// 示例值:7032210902531327521 + /// + [JsonPropertyName("offer_id")] + public string? OfferId { get; set; } + + /// + /// Offer HR 的 雇佣 ID,可以通过[批量查询员工信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)接口获取详情,user_id_type使用people_corehr_id类型 + /// 必填:否 + /// 示例值:7032210902531327521 + /// + [JsonPropertyName("offer_hr_id")] + public string? OfferHrId { get; set; } + + /// + /// 入职方式,枚举值可查询[获取字段详情](https://open.feishu.cn/document/server-docs/corehr-v1/basic-infomation/custom_field/get_by_param)接口获取,按如下参数查询即可: + /// - object_api_name = pre_hire + /// - custom_api_name = onboarding_method + /// 必填:否 + /// 示例值:onsite + /// + [JsonPropertyName("entry_mode")] + public string? EntryMode { get; set; } + + /// + /// 入职日期,时间格式为 2023-09-01 + /// 必填:否 + /// 示例值:2022-10-08 + /// + [JsonPropertyName("onboarding_date")] + public string? OnboardingDate { get; set; } + + /// + /// 招聘投递 ID ,详细信息可以通过招聘[获取投递信息](https://open.feishu.cn/document/server-docs/hire-v1/candidate-management/delivery-process-management/application/get)接口查询获得详情 + /// 必填:否 + /// 示例值:7140946969586010376 + /// + [JsonPropertyName("ats_application_id")] + public string? AtsApplicationId { get; set; } + + /// + /// 招聘来源 ,枚举值可查询[获取字段详情](https://open.feishu.cn/document/server-docs/corehr-v1/basic-infomation/custom_field/get_by_param)接口获取,按如下参数查询即可: + /// - object_api_name = pre_hire + /// - custom_api_name = recruitment_type + /// 必填:否 + /// 示例值:recent_graduates + /// + [JsonPropertyName("recruitment_type")] + public string? RecruitmentType { get; set; } + + /// + /// 入职地点 ID,详细信息可通过[查询单个地点](https://open.feishu.cn/document/server-docs/corehr-v1/organization-management/location/get)接口获得 + /// 必填:否 + /// 示例值:6977976687350924832 + /// + [JsonPropertyName("onboarding_location_id")] + public string? OnboardingLocationId { get; set; } + + /// + /// 需要公司办理签证 + /// 必填:否 + /// 示例值:true + /// + [JsonPropertyName("company_sponsored_visa")] + public bool? CompanySponsoredVisa { get; set; } + + /// + /// 入职状态 + /// 必填:否 + /// 示例值:preboarding + /// 可选值: + /// preboarding:待入职 + /// deleted:已删除 + /// day_one:准备就绪 + /// withdrawn:已撤销 + /// completed:已完成 + /// + /// + [JsonPropertyName("onboarding_status")] + public string? OnboardingStatus { get; set; } + + /// + /// 入职任务列表 + /// 必填:否 + /// + [JsonPropertyName("onboarding_task_list")] + public OnboardingTask[]? OnboardingTaskLists { get; set; } + + /// + /// 入职任务列表 + /// + public record OnboardingTask + { + /// + /// 任务名称 + /// 必填:否 + /// 示例值:task_1 + /// + [JsonPropertyName("task_name")] + public string? TaskName { get; set; } + + /// + /// 任务名称 + /// 必填:否 + /// 示例值:task_1 + /// 可选值: + /// initiating:发起中 + /// terminated:已终止 + /// exception:异常 + /// in_progress:进行中 + /// not_started:未开始 + /// skipped:已跳过 + /// uninitialized:未初始化 + /// failed:已失败 + /// in_review:审核中 + /// rejected:已退回 + /// completed:已完成 + /// + /// + [JsonPropertyName("task_status")] + public string? TaskStatus { get; set; } + + /// + /// 当前操作人雇佣 ID,可以通过[批量查询员工信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)接口获取详情,user_id_type使用people_corehr_id类型 + /// 必填:否 + /// 示例值:7032210902531327521 + /// + [JsonPropertyName("operator_id")] + public string? OperatorId { get; set; } + + /// + /// 任务code + /// 必填:否 + /// 示例值:task_11 + /// + [JsonPropertyName("task_code")] + public string? TaskCode { get; set; } + } + + /// + /// 入职地址 + /// 必填:否 + /// + [JsonPropertyName("onboarding_address")] + public Address? OnboardingAddress { get; set; } + + /// + /// 入职地址 + /// + public record Address + { + /// + /// 完整地址(本地文字) + /// 必填:否 + /// 示例值:中国北京北京 + /// + [JsonPropertyName("full_address_local_script")] + public string? FullAddressLocalScript { get; set; } + + /// + /// 完整地址(西方文字) + /// 必填:否 + /// 示例值:Beijing, Beijing, China, + /// + [JsonPropertyName("full_address_western_script")] + public string? FullAddressWesternScript { get; set; } + + /// + /// 地址 ID + /// 必填:否 + /// 示例值:6989822217869624863 + /// + [JsonPropertyName("address_id")] + public string? AddressId { get; set; } + + /// + /// 国家 / 地区,可以通过接口[查询国家/地区信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region/search)获取详情 + /// 必填:是 + /// 示例值:6862995757234914824 + /// + [JsonPropertyName("country_region_id")] + public string CountryRegionId { get; set; } = string.Empty; + + /// + /// 主要行政区ID 可以通过[查询省份/行政区信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region_subdivision/search)接口获取详情 + /// 必填:否 + /// 示例值:6863326815667095047 + /// + [JsonPropertyName("region_id")] + public string? RegionId { get; set; } + + /// + /// 地址行 1 + /// 必填:否 + /// 示例值:丹佛测试地址-纽埃时区 + /// + [JsonPropertyName("address_line1")] + public string? AddressLine1 { get; set; } + + /// + /// 地址行 2 + /// 必填:否 + /// 示例值:PoewH + /// + [JsonPropertyName("address_line2")] + public string? AddressLine2 { get; set; } + + /// + /// 地址行 3 + /// 必填:否 + /// 示例值:PoewH + /// + [JsonPropertyName("address_line3")] + public string? AddressLine3 { get; set; } + + /// + /// 地址行 4 + /// 必填:否 + /// 示例值:jmwJc + /// + [JsonPropertyName("address_line4")] + public string? AddressLine4 { get; set; } + + /// + /// 地址行 5 + /// 必填:否 + /// 示例值:jmwJc + /// + [JsonPropertyName("address_line5")] + public string? AddressLine5 { get; set; } + + /// + /// 地址行 6 + /// 必填:否 + /// 示例值:jmwJc + /// + [JsonPropertyName("address_line6")] + public string? AddressLine6 { get; set; } + + /// + /// 地址行 7 + /// 必填:否 + /// 示例值:jmwJc + /// + [JsonPropertyName("address_line7")] + public string? AddressLine7 { get; set; } + + /// + /// 地址行 8 + /// 必填:否 + /// 示例值:rafSu + /// + [JsonPropertyName("address_line8")] + public string? AddressLine8 { get; set; } + + /// + /// 地址行 9 + /// 必填:否 + /// 示例值:McPRG + /// + [JsonPropertyName("address_line9")] + public string? AddressLine9 { get; set; } + + /// + /// 地址行 1(非拉丁语系的本地文字) + /// 必填:否 + /// 示例值:丹佛测试地址-纽埃时区 + /// + [JsonPropertyName("local_address_line1")] + public string? LocalAddressLine1 { get; set; } + + /// + /// 地址行 2(非拉丁语系的本地文字) + /// 必填:否 + /// 示例值:PoewH + /// + [JsonPropertyName("local_address_line2")] + public string? LocalAddressLine2 { get; set; } + + /// + /// 地址行 3(非拉丁语系的本地文字) + /// 必填:否 + /// 示例值:PoewH + /// + [JsonPropertyName("local_address_line3")] + public string? LocalAddressLine3 { get; set; } + + /// + /// 地址行 4(非拉丁语系的本地文字) + /// 必填:否 + /// 示例值:jmwJc + /// + [JsonPropertyName("local_address_line4")] + public string? LocalAddressLine4 { get; set; } + + /// + /// 地址行 5(非拉丁语系的本地文字) + /// 必填:否 + /// 示例值:jmwJc + /// + [JsonPropertyName("local_address_line5")] + public string? LocalAddressLine5 { get; set; } + + /// + /// 地址行 6(非拉丁语系的本地文字) + /// 必填:否 + /// 示例值:jmwJc + /// + [JsonPropertyName("local_address_line6")] + public string? LocalAddressLine6 { get; set; } + + /// + /// 地址行 7(非拉丁语系的本地文字) + /// 必填:否 + /// 示例值:jmwJc + /// + [JsonPropertyName("local_address_line7")] + public string? LocalAddressLine7 { get; set; } + + /// + /// 地址行 8(非拉丁语系的本地文字) + /// 必填:否 + /// 示例值:rafSu + /// + [JsonPropertyName("local_address_line8")] + public string? LocalAddressLine8 { get; set; } + + /// + /// 地址行 9(非拉丁语系的本地文字) + /// 必填:否 + /// 示例值:McPRG + /// + [JsonPropertyName("local_address_line9")] + public string? LocalAddressLine9 { get; set; } + + /// + /// 邮政编码 + /// 必填:否 + /// 示例值:611530 + /// + [JsonPropertyName("postal_code")] + public string? PostalCode { get; set; } + + /// + /// 地址类型,枚举值可通过文档[枚举常量介绍](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/feishu-people-enum-constant)地址类型(address_type)枚举定义获得 + /// 必填:是 + /// + [JsonPropertyName("address_type_list")] + public Enum[] AddressTypeLists { get; set; } = Array.Empty(); + + /// + /// 地址类型,枚举值可通过文档[枚举常量介绍](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/feishu-people-enum-constant)地址类型(address_type)枚举定义获得 + /// + public record Enum + { + /// + /// 枚举值 + /// 必填:是 + /// 示例值:phone_type + /// + [JsonPropertyName("enum_name")] + public string EnumName { get; set; } = string.Empty; + + /// + /// 枚举多语展示 + /// 必填:否 + /// + [JsonPropertyName("display")] + public I18n[]? Displies { get; set; } + + /// + /// 枚举多语展示 + /// + public record I18n + { + /// + /// 语言编码(IETF BCP 47) + /// 必填:是 + /// 示例值:zh-CN + /// + [JsonPropertyName("lang")] + public string Lang { get; set; } = string.Empty; + + /// + /// 文本内容 + /// 必填:是 + /// 示例值:中文示例 + /// + [JsonPropertyName("value")] + public string Value { get; set; } = string.Empty; + } + } + + /// + /// 主要地址 + /// 必填:是 + /// 示例值:true + /// + [JsonPropertyName("is_primary")] + public bool IsPrimary { get; set; } + + /// + /// 公开地址 + /// 必填:是 + /// 示例值:true + /// + [JsonPropertyName("is_public")] + public bool IsPublic { get; set; } + + /// + /// 自定义字段 + /// 必填:否 + /// + [JsonPropertyName("custom_fields")] + public CustomFieldData[]? CustomFields { get; set; } + + /// + /// 自定义字段 + /// + public record CustomFieldData + { + /// + /// 自定义字段 apiname,即自定义字段的唯一标识 + /// 必填:是 + /// 示例值:name + /// + [JsonPropertyName("custom_api_name")] + public string CustomApiName { get; set; } = string.Empty; + + /// + /// 自定义字段名称 + /// 必填:否 + /// + [JsonPropertyName("name")] + public CustomName? Name { get; set; } + + /// + /// 自定义字段名称 + /// + public record CustomName + { + /// + /// 中文 + /// 必填:否 + /// 示例值:自定义姓名 + /// + [JsonPropertyName("zh_cn")] + public string? ZhCn { get; set; } + + /// + /// 英文 + /// 必填:否 + /// 示例值:Custom Name + /// + [JsonPropertyName("en_us")] + public string? EnUs { get; set; } + } + + /// + /// 自定义字段类型 + /// 值类型说明: + /// - 1:文本 Text,“文本”和“超链接”属于该类型 + /// - 2:布尔 Boolean + /// - 3:数字 Number + /// - 4:枚举 Option,“单选”和“多选”为该类型 + /// - 5:查找 Lookup,“人员(单选)”、“人员(多选)”和个人信息中的自定义分组为该类型 + /// - 6:自动编码 Autonumber + /// - 7:日期时间 Datetime + /// - 8:附件 Attachment,“附件单选”和“附件多选”为该类型 + /// - 9:图片 Image + /// - 10:计算字段 Calculated + /// - 11:反向查找 Backlookup + /// 必填:否 + /// 示例值:1 + /// + [JsonPropertyName("type")] + public int? Type { get; set; } + + /// + /// 字段值,是 json 转义后的字符串,根据元数据定义不同,字段格式不同(如 123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05") + /// 必填:是 + /// 示例值:\"231\" + /// + [JsonPropertyName("value")] + public string Value { get; set; } = string.Empty; + } + } + + /// + /// 入职流程 + /// 必填:否 + /// + [JsonPropertyName("flow_name")] + public I18n[]? FlowNames { get; set; } + + /// + /// 入职流程 + /// + public record I18n + { + /// + /// 语言编码(IETF BCP 47) + /// 必填:是 + /// 示例值:zh-CN + /// + [JsonPropertyName("lang")] + public string Lang { get; set; } = string.Empty; + + /// + /// 文本内容 + /// 必填:是 + /// 示例值:中文示例 + /// + [JsonPropertyName("value")] + public string Value { get; set; } = string.Empty; + } + + /// + /// 入职流程 ID + /// 必填:否 + /// 示例值:2342352325 + /// + [JsonPropertyName("flow_id")] + public string? FlowId { get; set; } + + /// + /// 签到时间,时间格式为 2023-09-01 13:21:12 + /// 必填:否 + /// 示例值:2023-09-01 13:21:12 + /// + [JsonPropertyName("check_in_time")] + public string? CheckInTime { get; set; } + + /// + /// 招聘来源,枚举值可查询[获取字段详情](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口获取,按如下参数查询即可: + /// - custom_api_name:check_in_method + /// - object_api_name:pre_hire + /// 必填:否 + /// + [JsonPropertyName("check_in_method")] + public Enum? CheckInMethod { get; set; } + + /// + /// 招聘来源,枚举值可查询[获取字段详情](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口获取,按如下参数查询即可: + /// - custom_api_name:check_in_method + /// - object_api_name:pre_hire + /// + public record Enum + { + /// + /// 枚举值 + /// 必填:是 + /// 示例值:phone_type + /// + [JsonPropertyName("enum_name")] + public string EnumName { get; set; } = string.Empty; + + /// + /// 枚举多语展示 + /// 必填:否 + /// + [JsonPropertyName("display")] + public I18n[]? Displies { get; set; } + + /// + /// 枚举多语展示 + /// + public record I18n + { + /// + /// 语言编码(IETF BCP 47) + /// 必填:是 + /// 示例值:zh-CN + /// + [JsonPropertyName("lang")] + public string Lang { get; set; } = string.Empty; + + /// + /// 文本内容 + /// 必填:是 + /// 示例值:中文示例 + /// + [JsonPropertyName("value")] + public string Value { get; set; } = string.Empty; + } + } + } + + /// + /// 试用期信息 + /// 必填:否 + /// + [JsonPropertyName("probation_info")] + public PreHireProbationInfo? ProbationInfo { get; set; } + + /// + /// 试用期信息 + /// + public record PreHireProbationInfo + { + /// + /// 试用期开始日期,时间格式为 2023-09-01 + /// 必填:否 + /// 示例值:2022-07-29 + /// + [JsonPropertyName("probation_start_date")] + public string? ProbationStartDate { get; set; } + + /// + /// 试用期结束日期,时间格式为 2023-09-01 + /// 必填:否 + /// 示例值:2023-04-07 + /// + [JsonPropertyName("probation_end_date")] + public string? ProbationEndDate { get; set; } + + /// + /// 试用期时长(单位:天) + /// 必填:否 + /// 示例值:6 + /// + [JsonPropertyName("probation_period")] + public int? ProbationPeriod { get; set; } + } + + /// + /// 合同信息 + /// 必填:否 + /// + [JsonPropertyName("contract_info")] + public PreHireContractInfo? ContractInfo { get; set; } + + /// + /// 合同信息 + /// + public record PreHireContractInfo + { + /// + /// 合同开始日期,时间格式为 2023-09-01 + /// 必填:否 + /// 示例值:2022-10-08 + /// + [JsonPropertyName("contract_start_date")] + public string? ContractStartDate { get; set; } + + /// + /// 合同结束日期,时间格式为 2023-09-01 + /// 必填:否 + /// 示例值:2025-10-07 + /// + [JsonPropertyName("contract_end_date")] + public string? ContractEndDate { get; set; } + + /// + /// 合同类型,枚举值可查询[获取字段详情](https://open.feishu.cn/document/server-docs/corehr-v1/basic-infomation/custom_field/get_by_param)接口获取,按如下参数查询即可: + /// - object_api_name = pre_hire + /// - custom_api_name = contract_type + /// 必填:否 + /// 示例值:labor_contract + /// + [JsonPropertyName("contract_type")] + public string? ContractType { get; set; } + + /// + /// 期限类型,枚举值可查询[获取字段详情](https://open.feishu.cn/document/server-docs/corehr-v1/basic-infomation/custom_field/get_by_param)接口获取,按如下参数查询即可: + /// - object_api_name = pre_hire + /// - custom_api_name = duration_type + /// 必填:否 + /// 示例值:fixed_term + /// + [JsonPropertyName("duration_type")] + public string? DurationType { get; set; } + + /// + /// 签订类型,枚举值可查询[获取字段详情](https://open.feishu.cn/document/server-docs/corehr-v1/basic-infomation/custom_field/get_by_param)接口获取,按如下参数查询即可: + /// - object_api_name = pre_hire + /// - custom_api_name = signing_type + /// 必填:否 + /// 示例值:renewed + /// + [JsonPropertyName("signing_type")] + public string? SigningType { get; set; } + } + + /// + /// 待入职 id + /// 必填:否 + /// 示例值:7032210902531327521 + /// + [JsonPropertyName("pre_hire_id")] + public string? PreHireId { get; set; } + } + + /// + /// 分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token + /// 必填:否 + /// 示例值:eVQrYzJBNDNONlk4VFZBZVlSdzlKdFJ4bVVHVExENDNKVHoxaVdiVnViQT0= + /// + [JsonPropertyName("page_token")] + public string? PageToken { get; set; } + + /// + /// 是否还有更多项 + /// 必填:否 + /// 示例值:true + /// + [JsonPropertyName("has_more")] + public bool? HasMore { get; set; } +} diff --git a/src/Corehr/PostCorehrV2ProbationSearchBodyDto.cs b/src/Corehr/PostCorehrV2ProbationSearchBodyDto.cs index ec95fd17..f9aa1124 100644 --- a/src/Corehr/PostCorehrV2ProbationSearchBodyDto.cs +++ b/src/Corehr/PostCorehrV2ProbationSearchBodyDto.cs @@ -14,7 +14,7 @@ namespace FeishuNetSdk.Corehr; /// /// 搜索试用期信息 请求体 -/// 搜索试用期信息 +/// 搜索试用期信息,创建试用期后立刻搜索,可能会存在 5s 左右延迟 /// 接口ID:7254814386694553602 /// 文档地址:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/probation/search /// JSON地址:https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2fcorehr-v2%2fprobation%2fsearch @@ -22,21 +22,21 @@ namespace FeishuNetSdk.Corehr; public record PostCorehrV2ProbationSearchBodyDto { /// - /// 雇佣 ID 列表 + /// 雇佣 ID 列表,可通过[【搜索员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/search)接口获取 /// 必填:否 /// [JsonPropertyName("employment_ids")] public string[]? EmploymentIds { get; set; } /// - /// 部门 ID 列表 + /// 部门 ID 列表,可通过[【批量查询部门】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/department/batch_get)接口获取 /// 必填:否 /// [JsonPropertyName("department_ids")] public string[]? DepartmentIds { get; set; } /// - /// 试用期开始日期 - 搜索范围开始,需要与搜索范围结束一同使用 + /// 试用期开始日期 - 搜索范围开始,需要与搜索范围结束一同使用,格式:"YYYY-MM-DD" /// 必填:否 /// 示例值:2022-05-18 /// @@ -44,7 +44,7 @@ public record PostCorehrV2ProbationSearchBodyDto public string? ProbationStartDateStart { get; set; } /// - /// 试用期开始日期 - 搜索范围结束 + /// 试用期开始日期 - 搜索范围结束,格式:"YYYY-MM-DD" /// 必填:否 /// 示例值:2022-05-20 /// @@ -52,7 +52,7 @@ public record PostCorehrV2ProbationSearchBodyDto public string? ProbationStartDateEnd { get; set; } /// - /// 试用期预计结束日期 - 搜索范围开始,需要与搜索范围结束一同使用 + /// 试用期预计结束日期 - 搜索范围开始,需要与搜索范围结束一同使用,格式:"YYYY-MM-DD" /// 必填:否 /// 示例值:2022-06-20 /// @@ -60,7 +60,7 @@ public record PostCorehrV2ProbationSearchBodyDto public string? ProbationExpectedEndDateStart { get; set; } /// - /// 试用期预计结束日期 - 搜索范围结束 + /// 试用期预计结束日期 - 搜索范围结束,格式:"YYYY-MM-DD" /// 必填:否 /// 示例值:2022-07-20 /// @@ -68,7 +68,7 @@ public record PostCorehrV2ProbationSearchBodyDto public string? ProbationExpectedEndDateEnd { get; set; } /// - /// 试用期实际结束日期 - 搜索范围开始,需要与搜索范围结束一同使用 + /// 试用期实际结束日期 - 搜索范围开始,需要与搜索范围结束一同使用,格式:"YYYY-MM-DD" /// 必填:否 /// 示例值:2022-08-20 /// @@ -76,7 +76,7 @@ public record PostCorehrV2ProbationSearchBodyDto public string? ActualProbationEndDateStart { get; set; } /// - /// 试用期实际结束日期 - 搜索范围结束 + /// 试用期实际结束日期 - 搜索范围结束,格式:"YYYY-MM-DD" /// 必填:否 /// 示例值:2022-09-20 /// @@ -84,7 +84,7 @@ public record PostCorehrV2ProbationSearchBodyDto public string? ActualProbationEndDateEnd { get; set; } /// - /// 转正发起日期 - 搜索范围开始,需要与搜索范围结束一同使用 + /// 转正发起日期 - 搜索范围开始,需要与搜索范围结束一同使用,格式:"YYYY-MM-DD" /// 必填:否 /// 示例值:2022-10-20 /// @@ -92,7 +92,7 @@ public record PostCorehrV2ProbationSearchBodyDto public string? InitiatingTimeStart { get; set; } /// - /// 转正发起日期 - 搜索范围结束 + /// 转正发起日期 - 搜索范围结束,格式:"YYYY-MM-DD" /// 必填:否 /// 示例值:2022-11-20 /// diff --git a/src/Corehr/PostCorehrV2ProbationSearchResponseDto.cs b/src/Corehr/PostCorehrV2ProbationSearchResponseDto.cs index ac7ee70b..c74b4ccf 100644 --- a/src/Corehr/PostCorehrV2ProbationSearchResponseDto.cs +++ b/src/Corehr/PostCorehrV2ProbationSearchResponseDto.cs @@ -14,7 +14,7 @@ namespace FeishuNetSdk.Corehr; /// /// 搜索试用期信息 响应体 -/// 搜索试用期信息 +/// 搜索试用期信息,创建试用期后立刻搜索,可能会存在 5s 左右延迟 /// 接口ID:7254814386694553602 /// 文档地址:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/probation/search /// JSON地址:https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2fcorehr-v2%2fprobation%2fsearch @@ -34,7 +34,7 @@ public record PostCorehrV2ProbationSearchResponseDto public record ProbationInfo { /// - /// 雇佣 ID + /// 雇佣 ID,可通过[【搜索员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/search)接口获取 /// 必填:否 /// 示例值:6893014062142064135 /// @@ -50,7 +50,7 @@ public record ProbationInfo public string? ProbationId { get; set; } /// - /// 试用期开始日期 + /// 试用期开始日期,格式:"YYYY-MM-DD" /// 必填:否 /// 示例值:2022-05-20 /// @@ -58,7 +58,7 @@ public record ProbationInfo public string? ProbationStartDate { get; set; } /// - /// 试用期预计结束日期 + /// 试用期预计结束日期,格式:"YYYY-MM-DD" /// 必填:否 /// 示例值:2022-05-28 /// @@ -66,7 +66,7 @@ public record ProbationInfo public string? ProbationExpectedEndDate { get; set; } /// - /// 试用期实际结束日期 + /// 试用期实际结束日期,格式:"YYYY-MM-DD" /// 必填:否 /// 示例值:2022-06-28 /// @@ -74,7 +74,7 @@ public record ProbationInfo public string? ActualProbationEndDate { get; set; } /// - /// 转正发起日期 + /// 转正发起日期,格式:"YYYY-MM-DD" /// 必填:否 /// 示例值:2022-07-28 /// @@ -139,7 +139,7 @@ public record I18n } /// - /// 转正发起人的雇佣 ID,当系统发起转正时该字段为空 + /// 转正发起人的雇佣 ID,当系统发起转正时该字段为空,可通过[【搜索员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/search)接口获取 /// 必填:否 /// 示例值:6893014062142061135 /// @@ -235,7 +235,7 @@ public record CustomName /// /// 英文 /// 必填:否 - /// 示例值:CustomName + /// 示例值:Custom Name /// [JsonPropertyName("en_us")] public string? EnUs { get; set; } diff --git a/src/Corehr/PostCorehrV2ProbationSubmitBodyDto.cs b/src/Corehr/PostCorehrV2ProbationSubmitBodyDto.cs new file mode 100644 index 00000000..7deaa2e8 --- /dev/null +++ b/src/Corehr/PostCorehrV2ProbationSubmitBodyDto.cs @@ -0,0 +1,154 @@ +// ************************************************************************ +// Assembly : FeishuNetSdk +// Author : yxr +// Created : 2024-07-18 +// +// Last Modified By : yxr +// Last Modified On : 2024-07-18 +// ************************************************************************ +// +// MIT +// +// 发起转正 请求体 +// ************************************************************************ +namespace FeishuNetSdk.Corehr; +/// +/// 发起转正 请求体 +/// 通过本接口可以为员工发起转正 +/// 接口ID:7254814386694635522 +/// 文档地址:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/probation/submit +/// JSON地址:https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2fcorehr-v2%2fprobation%2fsubmit +/// +public record PostCorehrV2ProbationSubmitBodyDto +{ + /// + /// 试用期人员的雇佣 ID,可通过[【搜索员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/search)接口获取 + /// 必填:是 + /// 示例值:7140964208476371111 + /// + [JsonPropertyName("employment_id")] + public string EmploymentId { get; set; } = string.Empty; + + /// + /// 转正方式 + /// 必填:是 + /// 示例值:1 + /// 可选值: + /// 1:直接转正 + /// 2:发起转正 + /// + /// + [JsonPropertyName("conversion_mode")] + public int ConversionMode { get; set; } + + /// + /// 实际结束日期,如果为空则默认填入试用期预计结束日期,填入日期需满足:试用期开始时间 <= 实际结束日期 <= 试用期预计结束日期,格式:"YYYY-MM-DD" + /// 必填:否 + /// 示例值:2022-05-20 + /// + [JsonPropertyName("actual_probation_end_date")] + public string? ActualProbationEndDate { get; set; } + + /// + /// 发起方 + /// 必填:是 + /// 示例值:system + /// 可选值: + /// self_submission:员工 + /// system:系统 + /// hr_submission:HR + /// + /// + [JsonPropertyName("submission_type")] + public string SubmissionType { get; set; } = string.Empty; + + /// + /// 发起人 ID,当发起方为 HR 时填写,为其他发起方时该字段会自动计算,可通过[【搜索员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/search)接口获取 + /// 必填:否 + /// 示例值:7140964208476371111 + /// + [JsonPropertyName("initiator_id")] + public string? InitiatorId { get; set; } + + /// + /// 备注,当为直接转正时必填 + /// 必填:否 + /// 示例值:符合预期 + /// + [JsonPropertyName("notes")] + public string? Notes { get; set; } + + /// + /// 员工自评 + /// 必填:否 + /// 示例值:符合预期 + /// + [JsonPropertyName("self_review")] + public string? SelfReview { get; set; } + + /// + /// 自定义字段(试用期中如果有附件自定义字段,当前不支持使用「上传文件」接口写入) + /// 必填:否 + /// + [JsonPropertyName("custom_fields")] + public CustomFieldData[]? CustomFields { get; set; } + + /// + /// 自定义字段(试用期中如果有附件自定义字段,当前不支持使用「上传文件」接口写入) + /// + public record CustomFieldData + { + /// + /// 自定义字段 apiname,即自定义字段的唯一标识 + /// 必填:是 + /// 示例值:name + /// + [JsonPropertyName("custom_api_name")] + public string CustomApiName { get; set; } = string.Empty; + + /// + /// 自定义字段名称 + /// 必填:否 + /// + [JsonPropertyName("name")] + public CustomName? Name { get; set; } + + /// + /// 自定义字段名称 + /// + public record CustomName + { + /// + /// 中文 + /// 必填:否 + /// 示例值:自定义姓名 + /// + [JsonPropertyName("zh_cn")] + public string? ZhCn { get; set; } + + /// + /// 英文 + /// 必填:否 + /// 示例值:Custom Name + /// + [JsonPropertyName("en_us")] + public string? EnUs { get; set; } + } + + /// + /// 自定义字段类型 + /// 必填:否 + /// 示例值:1 + /// + [JsonPropertyName("type")] + public int? Type { get; set; } + + /// + /// 字段值,是 json 转义后的字符串,根据元数据定义不同,字段格式不同(如 123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05") + /// 必填:是 + /// 示例值:\"231\" + /// + [JsonPropertyName("value")] + public string Value { get; set; } = string.Empty; + } +} diff --git a/src/Corehr/PostCorehrV2ProbationSubmitResponseDto.cs b/src/Corehr/PostCorehrV2ProbationSubmitResponseDto.cs new file mode 100644 index 00000000..39c32d37 --- /dev/null +++ b/src/Corehr/PostCorehrV2ProbationSubmitResponseDto.cs @@ -0,0 +1,297 @@ +// ************************************************************************ +// Assembly : FeishuNetSdk +// Author : yxr +// Created : 2024-07-18 +// +// Last Modified By : yxr +// Last Modified On : 2024-07-18 +// ************************************************************************ +// +// MIT +// +// 发起转正 响应体 +// ************************************************************************ +namespace FeishuNetSdk.Corehr; +/// +/// 发起转正 响应体 +/// 通过本接口可以为员工发起转正 +/// 接口ID:7254814386694635522 +/// 文档地址:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/probation/submit +/// JSON地址:https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2fcorehr-v2%2fprobation%2fsubmit +/// +public record PostCorehrV2ProbationSubmitResponseDto +{ + /// + /// 试用期信息 + /// 必填:否 + /// + [JsonPropertyName("probation_info")] + public ProbationInfoForSubmit? ProbationInfo { get; set; } + + /// + /// 试用期信息 + /// + public record ProbationInfoForSubmit + { + /// + /// 雇佣 ID + /// 必填:否 + /// 示例值:6893014062142064135 + /// + [JsonPropertyName("employment_id")] + public string? EmploymentId { get; set; } + + /// + /// 试用期信息 ID + /// 必填:否 + /// 示例值:6893014062142064132 + /// + [JsonPropertyName("probation_id")] + public string? ProbationId { get; set; } + + /// + /// 试用期开始日期 + /// 必填:否 + /// 示例值:2022-05-20 + /// + [JsonPropertyName("probation_start_date")] + public string? ProbationStartDate { get; set; } + + /// + /// 试用期预计结束日期 + /// 必填:否 + /// 示例值:2022-05-28 + /// + [JsonPropertyName("probation_expected_end_date")] + public string? ProbationExpectedEndDate { get; set; } + + /// + /// 试用期实际结束日期 + /// 必填:否 + /// 示例值:2022-06-28 + /// + [JsonPropertyName("actual_probation_end_date")] + public string? ActualProbationEndDate { get; set; } + + /// + /// 转正发起日期 + /// 必填:否 + /// 示例值:2022-07-28 + /// + [JsonPropertyName("initiating_time")] + public string? InitiatingTime { get; set; } + + /// + /// 发起方 + /// 必填:否 + /// 示例值:hr_submission + /// + [JsonPropertyName("submission_type")] + public Enum? SubmissionType { get; set; } + + /// + /// 发起方 + /// + public record Enum + { + /// + /// 枚举值 + /// 必填:是 + /// 示例值:phone_type + /// + [JsonPropertyName("enum_name")] + public string EnumName { get; set; } = string.Empty; + + /// + /// 枚举多语展示 + /// 必填:否 + /// + [JsonPropertyName("display")] + public I18n[]? Displies { get; set; } + + /// + /// 枚举多语展示 + /// + public record I18n + { + /// + /// 语言 + /// 必填:是 + /// 示例值:zh-CN + /// + [JsonPropertyName("lang")] + public string Lang { get; set; } = string.Empty; + + /// + /// 内容 + /// 必填:是 + /// 示例值:张三 + /// + [JsonPropertyName("value")] + public string Value { get; set; } = string.Empty; + } + } + + /// + /// 转正发起人的雇佣 ID,当系统发起转正时该字段为空 + /// 必填:否 + /// 示例值:6893014062142061135 + /// + [JsonPropertyName("initiator_id")] + public string? InitiatorId { get; set; } + + /// + /// 试用期状态 + /// 必填:否 + /// 示例值:converted + /// + [JsonPropertyName("probation_status")] + public Enum? ProbationStatus { get; set; } + + /// + /// 员工自评 + /// 必填:否 + /// 示例值:符合预期 + /// + [JsonPropertyName("self_review")] + public string? SelfReview { get; set; } + + /// + /// 备注 + /// 必填:否 + /// 示例值:高潜 + /// + [JsonPropertyName("notes")] + public string? Notes { get; set; } + + /// + /// 流程实例 ID + /// 必填:否 + /// 示例值:6893014062142164135 + /// + [JsonPropertyName("process_id")] + public string? ProcessId { get; set; } + + /// + /// 是否通过 BPM 转正 + /// 必填:否 + /// 示例值:false + /// + [JsonPropertyName("converted_via_bpm")] + public bool? ConvertedViaBpm { get; set; } + + /// + /// 自定义字段 + /// 必填:否 + /// + [JsonPropertyName("custom_fields")] + public CustomFieldData[]? CustomFields { get; set; } + + /// + /// 自定义字段 + /// + public record CustomFieldData + { + /// + /// 自定义字段 apiname,即自定义字段的唯一标识 + /// 必填:是 + /// 示例值:name + /// + [JsonPropertyName("custom_api_name")] + public string CustomApiName { get; set; } = string.Empty; + + /// + /// 自定义字段名称 + /// 必填:否 + /// + [JsonPropertyName("name")] + public CustomName? Name { get; set; } + + /// + /// 自定义字段名称 + /// + public record CustomName + { + /// + /// 中文 + /// 必填:否 + /// 示例值:自定义姓名 + /// + [JsonPropertyName("zh_cn")] + public string? ZhCn { get; set; } + + /// + /// 英文 + /// 必填:否 + /// 示例值:Custom Name + /// + [JsonPropertyName("en_us")] + public string? EnUs { get; set; } + } + + /// + /// 自定义字段类型 + /// 必填:否 + /// 示例值:1 + /// + [JsonPropertyName("type")] + public int? Type { get; set; } + + /// + /// 字段值,是 json 转义后的字符串,根据元数据定义不同,字段格式不同(如 123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05") + /// 必填:是 + /// 示例值:\"231\" + /// + [JsonPropertyName("value")] + public string Value { get; set; } = string.Empty; + } + + /// + /// 试用期考核最终状态 + /// 必填:否 + /// 示例值:completed + /// + [JsonPropertyName("final_assessment_status")] + public Enum? FinalAssessmentStatus { get; set; } + + /// + /// 试用期考核最终结果 + /// 必填:否 + /// 示例值:approved + /// + [JsonPropertyName("final_assessment_result")] + public Enum? FinalAssessmentResult { get; set; } + + /// + /// 试用期考核最终得分 + /// 必填:否 + /// 示例值:99.9 + /// + [JsonPropertyName("final_assessment_score")] + public float? FinalAssessmentScore { get; set; } + + /// + /// 试用期考核最终等级 + /// 必填:否 + /// 示例值:grade_a + /// + [JsonPropertyName("final_assessment_grade")] + public Enum? FinalAssessmentGrade { get; set; } + + /// + /// 试用期考核最终评语 + /// 必填:否 + /// 示例值:超出预期 + /// + [JsonPropertyName("final_assessment_comment")] + public string? FinalAssessmentComment { get; set; } + + /// + /// 最终考核结果页面超链接 + /// 必填:否 + /// 示例值:暂无示例 + /// + [JsonPropertyName("final_assessment_detail")] + public string? FinalAssessmentDetail { get; set; } + } +} diff --git a/src/Corehr/PostCorehrV2ProbationWithdrawBodyDto.cs b/src/Corehr/PostCorehrV2ProbationWithdrawBodyDto.cs new file mode 100644 index 00000000..82e7456d --- /dev/null +++ b/src/Corehr/PostCorehrV2ProbationWithdrawBodyDto.cs @@ -0,0 +1,31 @@ +// ************************************************************************ +// Assembly : FeishuNetSdk +// Author : yxr +// Created : 2024-07-18 +// +// Last Modified By : yxr +// Last Modified On : 2024-07-18 +// ************************************************************************ +// +// MIT +// +// 撤销转正 请求体 +// ************************************************************************ +namespace FeishuNetSdk.Corehr; +/// +/// 撤销转正 请求体 +/// 可通过本接口撤销对员工之前发起的转正 +/// 接口ID:7254814386694651906 +/// 文档地址:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/probation/withdraw +/// JSON地址:https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2fcorehr-v2%2fprobation%2fwithdraw +/// +public record PostCorehrV2ProbationWithdrawBodyDto +{ + /// + /// 试用期人员的雇佣 ID,可通过[【搜索员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/search)接口获取 + /// 必填:是 + /// 示例值:7140964208476371111 + /// + [JsonPropertyName("employment_id")] + public string EmploymentId { get; set; } = string.Empty; +} diff --git a/src/FeishuNetSdk.csproj b/src/FeishuNetSdk.csproj index 4dd4eeee..6e4092d7 100644 --- a/src/FeishuNetSdk.csproj +++ b/src/FeishuNetSdk.csproj @@ -16,7 +16,7 @@ MIT 适用于飞书开放平台的.Net开发包 LICENSE - 2.3.6 + 2.3.7 diff --git a/src/FeishuPeople/GetCorehrV1PreHiresByPreHireIdResponseDto.cs b/src/FeishuPeople/GetCorehrV1PreHiresByPreHireIdResponseDto.cs index 7e602238..8f0d698b 100644 --- a/src/FeishuPeople/GetCorehrV1PreHiresByPreHireIdResponseDto.cs +++ b/src/FeishuPeople/GetCorehrV1PreHiresByPreHireIdResponseDto.cs @@ -14,7 +14,7 @@ namespace FeishuNetSdk.FeishuPeople; /// /// 查询单个待入职信息 响应体 -/// 根据 ID 查询单个待入职人员。 +/// 根据 ID 查询单个待入职人员,本接口不再推荐使用(个人信息相关数据不完整),请使用[查询待入职](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/pre_hire/query)接口获取更完整信息。 /// 接口ID:7017707615191089155 /// 文档地址:https://open.feishu.cn/document/server-docs/corehr-v1/pre_hire/get /// JSON地址:https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fcorehr-v1%2fpre_hire%2fget @@ -34,7 +34,7 @@ public record GetCorehrV1PreHiresByPreHireIdResponseDto public record GetCorehrV1PreHiresByPreHireIdResponseDtoPreHire { /// - /// 招聘投递 ID ,详细信息可以通过招聘的【获取投递信息】接口查询获得(该接口仅部分租户可用) + /// 招聘投递 ID ,可以通过[获取投递列表](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/application/list)接口获取 /// 必填:否 /// 示例值:4719168654814483759 /// @@ -42,7 +42,7 @@ public record GetCorehrV1PreHiresByPreHireIdResponseDtoPreHire public string? AtsApplicationId { get; set; } /// - /// 待入职ID + /// 待入职ID,可从[待入职列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/pre_hire/search)接口获取 /// 必填:否 /// 示例值:154545454 /// @@ -50,7 +50,7 @@ public record GetCorehrV1PreHiresByPreHireIdResponseDtoPreHire public string? Id { get; set; } /// - /// 入职日期 + /// 入职日期,格式:"YYYY-MM-DD" /// 必填:否 /// 示例值:2020-01-01 /// @@ -58,14 +58,14 @@ public record GetCorehrV1PreHiresByPreHireIdResponseDtoPreHire public string? HireDate { get; set; } /// - /// 雇佣类型 + /// 人员类型 /// 必填:是 /// [JsonPropertyName("employee_type")] public Enum EmployeeType { get; set; } = new(); /// - /// 雇佣类型 + /// 人员类型 /// public record Enum { @@ -116,7 +116,7 @@ public record I18n public string? WorkerId { get; set; } /// - /// 雇佣类型 + /// 人员类型,可通过[【批量查询人员类型】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/employee_type/list)接口获取 /// 必填:是 /// 示例值:正式 /// @@ -124,7 +124,7 @@ public record I18n public string EmployeeTypeId { get; set; } = string.Empty; /// - /// 引用Person ID + /// 个人信息ID /// 必填:是 /// 示例值:656464648662 /// @@ -173,7 +173,7 @@ public record ObjectFieldData public record SupportCostCenterItem { /// - /// 支持的成本中心id + /// 支持的成本中心id,详细信息可通过[【搜索成本中心信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/cost_center/search)接口查询获得 /// 必填:否 /// 示例值:6950635856373745165 /// diff --git a/src/FeishuPeople/GetCorehrV1PreHiresResponseDto.cs b/src/FeishuPeople/GetCorehrV1PreHiresResponseDto.cs index 2b56e523..397e3b18 100644 --- a/src/FeishuPeople/GetCorehrV1PreHiresResponseDto.cs +++ b/src/FeishuPeople/GetCorehrV1PreHiresResponseDto.cs @@ -14,7 +14,7 @@ namespace FeishuNetSdk.FeishuPeople; /// /// 批量查询待入职信息 响应体 -/// 可通过本接口批量查询待入职人员信息,本接口和[搜索接口](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/pre_hire/search)相比较无延迟问题。 +/// 可通过本接口批量查询待入职人员信息,本接口不再推荐使用(个人信息相关数据不完整),请使用[查询待入职](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/pre_hire/query)接口获取更完整信息。 /// 接口ID:7017707615190958083 /// 文档地址:https://open.feishu.cn/document/server-docs/corehr-v1/pre_hire/list /// JSON地址:https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fcorehr-v1%2fpre_hire%2flist @@ -34,7 +34,7 @@ public record GetCorehrV1PreHiresResponseDto public record PreHireQuery { /// - /// 招聘投递 ID ,详细信息可以通过招聘的【获取投递信息】接口查询获得 + /// 招聘投递 ID ,可以通过[获取投递列表](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/application/list)接口获取 /// 必填:否 /// 示例值:4719168654814483759 /// @@ -42,7 +42,7 @@ public record PreHireQuery public string? AtsApplicationId { get; set; } /// - /// 实体在CoreHR内部的唯一键 + /// 待入职ID,可从[待入职列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/pre_hire/search)接口获取 /// 必填:否 /// 示例值:154545454 /// @@ -50,7 +50,7 @@ public record PreHireQuery public string? Id { get; set; } /// - /// 入职日期 + /// 入职日期,格式:"YYYY-MM-DD" /// 必填:否 /// 示例值:2020-01-01 /// @@ -116,7 +116,7 @@ public record I18n public string? WorkerId { get; set; } /// - /// 雇佣类型 + /// 人员类型,可通过[【批量查询人员类型】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/employee_type/list)接口获取 /// 必填:是 /// 示例值:正式 /// @@ -124,7 +124,7 @@ public record I18n public string EmployeeTypeId { get; set; } = string.Empty; /// - /// 引用Person ID + /// 个人信息 ID /// 必填:是 /// 示例值:656464648662 /// @@ -185,7 +185,7 @@ public record ObjectFieldData public record SupportCostCenterItem { /// - /// 支持的成本中心id + /// 支持的成本中心id,详细信息可通过[【搜索成本中心信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/cost_center/search)接口查询获得 /// 必填:否 /// 示例值:6950635856373745165 /// @@ -318,7 +318,7 @@ public record ObjectFieldData } /// - /// 部门ID + /// 部门ID,可通过[【批量查询部门】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/department/batch_get)接口获取 /// 必填:否 /// 示例值:656464648662 /// diff --git a/src/FeishuPeople/PostCorehrV1JobChangesBodyDto.cs b/src/FeishuPeople/PostCorehrV1JobChangesBodyDto.cs index 8966bdec..33330a48 100644 --- a/src/FeishuPeople/PostCorehrV1JobChangesBodyDto.cs +++ b/src/FeishuPeople/PostCorehrV1JobChangesBodyDto.cs @@ -4,7 +4,7 @@ // Created : 2024-06-24 // // Last Modified By : yxr -// Last Modified On : 2024-06-24 +// Last Modified On : 2024-07-18 // ************************************************************************ // // MIT @@ -14,7 +14,7 @@ namespace FeishuNetSdk.FeishuPeople; /// /// 发起员工异动 请求体 -/// 创建员工异动信息。 +/// 该接口用于发起员工异动(变更员工雇佣信息),若发起成功,会生成一条员工的异动数据,同时产生相应的事件:[异动状态变更事件](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_change/events/updated) /// 接口ID:7088940762189545473 /// 文档地址:https://open.feishu.cn/document/server-docs/corehr-v1/job_change/create /// JSON地址:https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fcorehr-v1%2fjob_change%2fcreate @@ -26,15 +26,17 @@ public record PostCorehrV1JobChangesBodyDto /// 必填:是 /// 示例值:2 /// 可选值: - /// 1:直接异动 - /// 2:发起异动 + /// 1:直接异动(无审批) + /// 2:正常异动(完整流程) /// /// [JsonPropertyName("transfer_mode")] public int TransferMode { get; set; } /// - /// 雇员id + /// 雇员ID,ID 类型与查询参数 user_id_type 的取值一致。 + /// - 当user_id_type=user_id时,该字段取员工的user_id,取值参考user_id_type部分。 + /// - 当user_id_type=people_corehr_id时,则取该员工的人事雇佣ID,可从[雇佣ID](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/search)接口获取。 /// 必填:是 /// 示例值:ou_a294793e8fa21529f2a60e3e9de45520 /// @@ -42,7 +44,9 @@ public record PostCorehrV1JobChangesBodyDto public string EmploymentId { get; set; } = string.Empty; /// - /// 异动类型唯一标识 + /// 异动类型唯一标识,可通过接口 + /// [获取异动类型列表 + /// ](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/transfer_type/query)获取 /// 必填:是 /// 示例值:internal_transfer /// @@ -50,7 +54,10 @@ public record PostCorehrV1JobChangesBodyDto public string TransferTypeUniqueIdentifier { get; set; } = string.Empty; /// - /// 关联流程唯一标识符,可通过「获取异动类型列表」接口获得 + /// 关联流程唯一标识符,可通过接口 + /// [获取异动类型列表 + /// ](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/transfer_type/query)获取 + /// 注意:当异动方式为2时,该字段为必填 /// 必填:否 /// 示例值:people_6963913041981490725_6983885526583627531 /// @@ -58,7 +65,7 @@ public record PostCorehrV1JobChangesBodyDto public string? FlowId { get; set; } /// - /// 生效日期 + /// 生效日期,格式:"YYYY-MM-DD" /// 必填:是 /// 示例值:2022-03-01 /// @@ -66,14 +73,14 @@ public record PostCorehrV1JobChangesBodyDto public string EffectiveDate { get; set; } = string.Empty; /// - /// 异动详细信息 + /// 异动详细信息,以下参数如不传,无默认值,代表对应数据无异动 /// 必填:是 /// [JsonPropertyName("transfer_info")] public PostCorehrV1JobChangesBodyDtoTransferInfo TransferInfo { get; set; } = new(); /// - /// 异动详细信息 + /// 异动详细信息,以下参数如不传,无默认值,代表对应数据无异动 /// public record PostCorehrV1JobChangesBodyDtoTransferInfo { @@ -110,7 +117,7 @@ public record PostCorehrV1JobChangesBodyDtoTransferInfo public bool? ProbationExist { get; set; } /// - /// 原部门 + /// 原部门ID,可通过[【批量查询部门】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/department/batch_get)接口获取 /// 必填:否 /// 示例值:6966236933198579208 /// @@ -118,7 +125,7 @@ public record PostCorehrV1JobChangesBodyDtoTransferInfo public string? OriginalDepartment { get; set; } /// - /// 新部门 + /// 新部门ID,可通过[【批量查询部门】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/department/batch_get)接口获取 /// 必填:否 /// 示例值:6966236933198579208 /// @@ -126,7 +133,7 @@ public record PostCorehrV1JobChangesBodyDtoTransferInfo public string? TargetDepartment { get; set; } /// - /// 原工作地点 + /// 原工作地点,可通过[【批量查询地点】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/location/list)接口获取 /// 必填:否 /// 示例值:6967271100992587295 /// @@ -134,7 +141,7 @@ public record PostCorehrV1JobChangesBodyDtoTransferInfo public string? OriginalWorkLocation { get; set; } /// - /// 新工作地点 + /// 新工作地点,可通过[【批量查询地点】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/location/list)接口获取 /// 必填:否 /// 示例值:6967271100992587295 /// @@ -142,7 +149,7 @@ public record PostCorehrV1JobChangesBodyDtoTransferInfo public string? TargetWorkLocation { get; set; } /// - /// 原直属上级 + /// 原直属上级,可通过[【搜索员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/search)接口获取 /// 必填:否 /// 示例值:6974641477444060708 /// @@ -150,7 +157,7 @@ public record PostCorehrV1JobChangesBodyDtoTransferInfo public string? OriginalDirectManager { get; set; } /// - /// 新直属上级 + /// 新直属上级,可通过[【搜索员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/search)接口获取 /// 必填:否 /// 示例值:7013619729281713671 /// @@ -158,7 +165,7 @@ public record PostCorehrV1JobChangesBodyDtoTransferInfo public string? TargetDirectManager { get; set; } /// - /// 原虚线上级 + /// 原虚线上级,可通过[【搜索员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/search)接口获取 /// 必填:否 /// 示例值:6974648866876573198 /// @@ -166,7 +173,7 @@ public record PostCorehrV1JobChangesBodyDtoTransferInfo public string? OriginalDottedManager { get; set; } /// - /// 新虚线上级 + /// 新虚线上级,可通过[【搜索员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/search)接口获取 /// 必填:否 /// 示例值:7013328578351842852 /// @@ -175,6 +182,7 @@ public record PostCorehrV1JobChangesBodyDtoTransferInfo /// /// 原职务 + /// 可通过[【批量查询职务】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job/list)接口获取 /// 必填:否 /// 示例值:6969469398088287751 /// @@ -183,6 +191,7 @@ public record PostCorehrV1JobChangesBodyDtoTransferInfo /// /// 新职务 + /// 可通过[【批量查询职务】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job/list)接口获取 /// 必填:否 /// 示例值:6969469557836760606 /// @@ -190,7 +199,7 @@ public record PostCorehrV1JobChangesBodyDtoTransferInfo public string? TargetJob { get; set; } /// - /// 原序列 + /// 原序列ID,可通过[【批量查询序列】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_family/list)接口获取 /// 必填:否 /// 示例值:6967287547462419975 /// @@ -198,7 +207,7 @@ public record PostCorehrV1JobChangesBodyDtoTransferInfo public string? OriginalJobFamily { get; set; } /// - /// 新序列 + /// 新序列ID,可通过[【批量查询序列】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_family/list)接口获取 /// 必填:否 /// 示例值:6967287547462419975 /// @@ -206,7 +215,8 @@ public record PostCorehrV1JobChangesBodyDtoTransferInfo public string? TargetJobFamily { get; set; } /// - /// 原级别 + /// 原职级ID + /// 可通过[【批量查询职级】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_level/list)接口获取 /// 必填:否 /// 示例值:6972085707674355214 /// @@ -214,7 +224,8 @@ public record PostCorehrV1JobChangesBodyDtoTransferInfo public string? OriginalJobLevel { get; set; } /// - /// 新级别 + /// 新职级ID + /// 可通过[【批量查询职级】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_level/list)接口获取 /// 必填:否 /// 示例值:6972085707674355214 /// @@ -222,7 +233,7 @@ public record PostCorehrV1JobChangesBodyDtoTransferInfo public string? TargetJobLevel { get; set; } /// - /// 原人员类型 + /// 原人员类型,可通过[【批量查询人员类型】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/employee_type/list)接口获取 /// 必填:否 /// 示例值:6968386026792289828 /// @@ -230,7 +241,7 @@ public record PostCorehrV1JobChangesBodyDtoTransferInfo public string? OriginalWorkforceType { get; set; } /// - /// 新人员类型 + /// 新人员类型,可通过[【批量查询人员类型】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/employee_type/list)接口获取 /// 必填:否 /// 示例值:7036268995372303885 /// @@ -238,7 +249,7 @@ public record PostCorehrV1JobChangesBodyDtoTransferInfo public string? TargetWorkforceType { get; set; } /// - /// 原公司 + /// 原公司,详细信息可通过[【批量查询公司】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/company/list)接口查询获得 /// 必填:否 /// 示例值:6974659700705068581 /// @@ -246,7 +257,7 @@ public record PostCorehrV1JobChangesBodyDtoTransferInfo public string? OriginalCompany { get; set; } /// - /// 新公司 + /// 新公司,详细信息可通过[【批量查询公司】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/company/list)接口查询获得 /// 必填:否 /// 示例值:6974659700705068581 /// @@ -254,7 +265,7 @@ public record PostCorehrV1JobChangesBodyDtoTransferInfo public string? TargetCompany { get; set; } /// - /// 原合同编号 + /// 原合同编号,可通过[【批量查询合同】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/contract/list)接口获取详细信息 /// 必填:否 /// 示例值:55332 /// @@ -262,7 +273,7 @@ public record PostCorehrV1JobChangesBodyDtoTransferInfo public string? OriginalContractNumber { get; set; } /// - /// 新合同编号 + /// 新合同编号,可通过[【批量查询合同】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/contract/list)接口获取详细信息 /// 必填:否 /// 示例值:55333 /// @@ -270,7 +281,7 @@ public record PostCorehrV1JobChangesBodyDtoTransferInfo public string? TargetContractNumber { get; set; } /// - /// 原合同类型 + /// 原合同类型,可通过[【批量查询合同】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/contract/list)接口获取详细信息 /// 必填:否 /// 示例值:labor_contract /// @@ -278,7 +289,7 @@ public record PostCorehrV1JobChangesBodyDtoTransferInfo public string? OriginalContractType { get; set; } /// - /// 新合同类型 + /// 新合同类型,可通过[【批量查询合同】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/contract/list)接口获取详细信息 /// 必填:否 /// 示例值:labor_contract /// @@ -286,7 +297,7 @@ public record PostCorehrV1JobChangesBodyDtoTransferInfo public string? TargetContractType { get; set; } /// - /// 原期限类型 + /// 原期限类型,可通过[【批量查询合同】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/contract/list)接口获取详细信息 /// 必填:否 /// 示例值:fixed_term /// @@ -294,7 +305,7 @@ public record PostCorehrV1JobChangesBodyDtoTransferInfo public string? OriginalDurationType { get; set; } /// - /// 新期限类型 + /// 新期限类型,可通过[【批量查询合同】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/contract/list)接口获取详细信息 /// 必填:否 /// 示例值:fixed_term /// @@ -302,7 +313,7 @@ public record PostCorehrV1JobChangesBodyDtoTransferInfo public string? TargetDurationType { get; set; } /// - /// 原签订类型 + /// 原签订类型,可通过[【批量查询合同】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/contract/list)接口获取详细信息 /// 必填:否 /// 示例值:new /// @@ -310,7 +321,7 @@ public record PostCorehrV1JobChangesBodyDtoTransferInfo public string? OriginalSigningType { get; set; } /// - /// 新签订类型 + /// 新签订类型,可通过[【批量查询合同】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/contract/list)接口获取详细信息 /// 必填:否 /// 示例值:new /// @@ -318,7 +329,7 @@ public record PostCorehrV1JobChangesBodyDtoTransferInfo public string? TargetSigningType { get; set; } /// - /// 原合同开始日期 + /// 原合同开始日期,格式:"YYYY-MM-DD" /// 必填:否 /// 示例值:2021-07-01 /// @@ -326,7 +337,7 @@ public record PostCorehrV1JobChangesBodyDtoTransferInfo public string? OriginalContractStartDate { get; set; } /// - /// 新合同开始日期 + /// 新合同开始日期,格式:"YYYY-MM-DD" /// 必填:否 /// 示例值:2021-07-01 /// @@ -334,7 +345,7 @@ public record PostCorehrV1JobChangesBodyDtoTransferInfo public string? TargetContractStartDate { get; set; } /// - /// 原合同结束日期 + /// 原合同结束日期,格式:"YYYY-MM-DD" /// 必填:否 /// 示例值:2024-07-01 /// @@ -342,7 +353,7 @@ public record PostCorehrV1JobChangesBodyDtoTransferInfo public string? OriginalContractEndDate { get; set; } /// - /// 新合同结束日期 + /// 新合同结束日期,格式:"YYYY-MM-DD" /// 必填:否 /// 示例值:2024-07-01 /// @@ -350,7 +361,7 @@ public record PostCorehrV1JobChangesBodyDtoTransferInfo public string? TargetContractEndDate { get; set; } /// - /// 原工时制度 + /// 原工时制度,可通过[【批量查询工时制度】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/working_hours_type/list)接口获取 /// 必填:否 /// 示例值:6969087376740206087 /// @@ -358,7 +369,7 @@ public record PostCorehrV1JobChangesBodyDtoTransferInfo public string? OriginalWorkingHoursType { get; set; } /// - /// 新工时制度 + /// 新工时制度,可通过[【批量查询工时制度】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/working_hours_type/list)接口获取 /// 必填:否 /// 示例值:6969087376740206087 /// @@ -366,7 +377,7 @@ public record PostCorehrV1JobChangesBodyDtoTransferInfo public string? TargetWorkingHoursType { get; set; } /// - /// 原工作日历 + /// 原工作日历,请开通休假服务后联系管理员获取工作日历数据 /// 必填:否 /// 示例值:6969087376740236087 /// @@ -374,7 +385,7 @@ public record PostCorehrV1JobChangesBodyDtoTransferInfo public string? OriginalWorkingCalendar { get; set; } /// - /// 新工作日历 + /// 新工作日历,请开通休假服务后联系管理员获取工作日历数据 /// 必填:否 /// 示例值:6969087376740236087 /// @@ -382,7 +393,7 @@ public record PostCorehrV1JobChangesBodyDtoTransferInfo public string? TargetWorkingCalendar { get; set; } /// - /// 原试用期预计结束日期 + /// 原试用期预计结束日期,格式:"YYYY-MM-DD" /// 必填:否 /// 示例值:2021-11-17 /// @@ -390,7 +401,7 @@ public record PostCorehrV1JobChangesBodyDtoTransferInfo public string? OriginalProbationEndDate { get; set; } /// - /// 新试用期预计结束日期 + /// 新试用期预计结束日期,格式:"YYYY-MM-DD" /// 必填:否 /// 示例值:2021-11-17 /// @@ -442,7 +453,7 @@ public record PostCorehrV1JobChangesBodyDtoTransferInfo public record SupportCostCenterItem { /// - /// 支持的成本中心id + /// 支持的成本中心id,详细信息可通过[【搜索成本中心信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/cost_center/search)接口查询获得 /// 必填:否 /// 示例值:6950635856373745165 /// @@ -464,10 +475,149 @@ public record SupportCostCenterItem /// [JsonPropertyName("target_cost_center_rate")] public SupportCostCenterItem[]? TargetCostCenterRates { get; set; } + + /// + /// 原工作信息 + /// 必填:否 + /// + [JsonPropertyName("original_employment_change")] + public TranferEmploymentInfo? OriginalEmploymentChange { get; set; } + + /// + /// 原工作信息 + /// + public record TranferEmploymentInfo + { + /// + /// 转正式员工日期,格式:"YYYY-MM-DD" + /// 必填:否 + /// 示例值:2023-01-01 + /// + [JsonPropertyName("regular_employee_start_date")] + public string? RegularEmployeeStartDate { get; set; } + + /// + /// 司龄起算日期,格式:"YYYY-MM-DD" + /// 必填:否 + /// 示例值:2023-01-01 + /// + [JsonPropertyName("seniority_date")] + public string? SeniorityDate { get; set; } + + /// + /// 员工编号,可通过[【搜索员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/search)接口获取 + /// 必填:否 + /// 示例值:1111111 + /// + [JsonPropertyName("employee_number")] + public string? EmployeeNumber { get; set; } + + /// + /// 自定义字段 + /// 必填:否 + /// + [JsonPropertyName("custom_fields")] + public CustomFieldData[]? CustomFields { get; set; } + + /// + /// 自定义字段 + /// + public record CustomFieldData + { + /// + /// 自定义字段 apiname,即自定义字段的唯一标识。可以通过[获取自定义字段列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/query)获取 + /// 必填:是 + /// 示例值:name + /// + [JsonPropertyName("custom_api_name")] + public string CustomApiName { get; set; } = string.Empty; + + /// + /// 字段值,是 json 转义后的字符串,根据元数据定义不同,字段格式不同(如 123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05") + /// 注意: + /// 1.枚举字段值可通过[获取字段详情](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)获取,参考接口返回的 字段详情 > 字段类型配置信息 > 选项配置信息 > 选项信息 > 枚举常量集 API name + /// 必填:是 + /// 示例值:231 + /// + [JsonPropertyName("value")] + public string Value { get; set; } = string.Empty; + } + } + + /// + /// 新工作信息 + /// 必填:否 + /// + [JsonPropertyName("target_employment_change")] + public TranferEmploymentInfo? TargetEmploymentChange { get; set; } + + /// + /// 原职等,可通过[【查询职等】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job_grade/query)接口获取 + /// 必填:否 + /// 示例值:7289005963599693366 + /// + [JsonPropertyName("original_job_grade")] + public string? OriginalJobGrade { get; set; } + + /// + /// 新职等,可通过[【查询职等】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job_grade/query)接口获取 + /// 必填:否 + /// 示例值:7289005963599693366 + /// + [JsonPropertyName("target_job_grade")] + public string? TargetJobGrade { get; set; } + + /// + /// 原薪资类型 + /// 必填:否 + /// 示例值:hourly + /// + [JsonPropertyName("original_compensation_type")] + public string? OriginalCompensationType { get; set; } + + /// + /// 新薪资类型 + /// 必填:否 + /// 示例值:salary + /// + [JsonPropertyName("target_compensation_type")] + public string? TargetCompensationType { get; set; } + + /// + /// 原任职公司,详细信息可通过[【批量查询公司】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/company/list)接口查询获得 + /// 必填:否 + /// 示例值:7289005963599693367 + /// + [JsonPropertyName("original_service_company")] + public string? OriginalServiceCompany { get; set; } + + /// + /// 新任职公司,详细信息可通过[【批量查询公司】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/company/list)接口查询获得 + /// 必填:否 + /// 示例值:7289005963599693367 + /// + [JsonPropertyName("target_service_company")] + public string? TargetServiceCompany { get; set; } + + /// + /// 原岗位,可通过[【岗职务管理-岗位】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/position/query)相关API获取(目前仅灰度部分租户,如需要请联系管理员开灰) + /// 必填:否 + /// 示例值:7289005963599693367 + /// + [JsonPropertyName("original_position")] + public string? OriginalPosition { get; set; } + + /// + /// 新岗位,可通过[【岗职务管理-岗位】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/position/query)相关API获取(目前仅灰度部分租户,如需要请联系管理员开灰) + /// 必填:否 + /// 示例值:7289005963599693367 + /// + [JsonPropertyName("target_position")] + public string? TargetPosition { get; set; } } /// - /// 异动记录标识符 + /// 发起异动幂等标志,发起失败可以重新用此标志继续请求 /// 必填:否 /// 示例值:transfer_3627531 /// @@ -475,7 +625,7 @@ public record SupportCostCenterItem public string? TransferKey { get; set; } /// - /// 异动发起人 ID + /// 异动发起人 ID,可通过[【搜索员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/search)接口获取 /// 必填:否 /// 示例值:ou_a294793e8fa21529f2a60e3e9de45520 /// diff --git a/src/FeishuPeople/PostCorehrV1JobChangesResponseDto.cs b/src/FeishuPeople/PostCorehrV1JobChangesResponseDto.cs index 0e35640f..b8d7df21 100644 --- a/src/FeishuPeople/PostCorehrV1JobChangesResponseDto.cs +++ b/src/FeishuPeople/PostCorehrV1JobChangesResponseDto.cs @@ -4,7 +4,7 @@ // Created : 2024-06-24 // // Last Modified By : yxr -// Last Modified On : 2024-06-24 +// Last Modified On : 2024-07-18 // ************************************************************************ // // MIT @@ -14,7 +14,7 @@ namespace FeishuNetSdk.FeishuPeople; /// /// 发起员工异动 响应体 -/// 创建员工异动信息。 +/// 该接口用于发起员工异动(变更员工雇佣信息),若发起成功,会生成一条员工的异动数据,同时产生相应的事件:[异动状态变更事件](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_change/events/updated) /// 接口ID:7088940762189545473 /// 文档地址:https://open.feishu.cn/document/server-docs/corehr-v1/job_change/create /// JSON地址:https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fcorehr-v1%2fjob_change%2fcreate @@ -22,7 +22,9 @@ namespace FeishuNetSdk.FeishuPeople; public record PostCorehrV1JobChangesResponseDto { /// - /// 异动记录 id + /// 异动记录 id,可通过接口 + /// [搜索异动信息 + /// ](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job_change/search)获取详细信息 /// 必填:否 /// 示例值:6991776076699549697 /// @@ -30,7 +32,7 @@ public record PostCorehrV1JobChangesResponseDto public string? JobChangeId { get; set; } /// - /// 雇员 id + /// 雇员 id,可通过[【搜索员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/search)接口获取 /// 必填:否 /// 示例值:ou_a294793e8fa21529f2a60e3e9de45520 /// @@ -42,18 +44,20 @@ public record PostCorehrV1JobChangesResponseDto /// 必填:否 /// 示例值:4 /// 可选值: - /// 0:Approving审批中 - /// 1:Approved审批通过 - /// 2:Transformed已异动 - /// 3:Rejected已拒绝 - /// 4:Cancelled已撤销 + /// 0:Approving 审批中 + /// 1:Approved 审批通过 + /// 2:Transformed 已异动 + /// 3:Rejected 已拒绝 + /// 4:Cancelled 已撤销 /// /// [JsonPropertyName("status")] public string? Status { get; set; } /// - /// 异动类型唯一标识 + /// 异动类型唯一标识,,可通过接口 + /// [获取异动类型列表 + /// ](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/transfer_type/query)获取详细信息 /// 必填:否 /// 示例值:direct_leader_change /// @@ -61,7 +65,9 @@ public record PostCorehrV1JobChangesResponseDto public string? TransferTypeUniqueIdentifier { get; set; } /// - /// 异动原因唯一标识 + /// 异动原因唯一标识,可通过接口 + /// [获取异动原因列表 + /// ](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/transfer_reason/query)获取详细信息 /// 必填:否 /// 示例值:involuntary_transfer /// @@ -69,7 +75,7 @@ public record PostCorehrV1JobChangesResponseDto public string? TransferReasonUniqueIdentifier { get; set; } /// - /// 异动发起后审批流程 id + /// 异动发起后审批流程 id,可通过【流程-获取单个流程列表】获取详细信息 /// 必填:否 /// 示例值:6991776078461142564 /// @@ -77,7 +83,7 @@ public record PostCorehrV1JobChangesResponseDto public string? ProcessId { get; set; } /// - /// 异动生效日期 + /// 异动生效日期,格式:"YYYY-MM-DD" /// 必填:否 /// 示例值:2022-03-01 /// @@ -85,7 +91,7 @@ public record PostCorehrV1JobChangesResponseDto public string? EffectiveDate { get; set; } /// - /// 创建时间 + /// 创建时间,格式:"YYYY-MM-DD" /// 必填:否 /// 示例值:1627899724000 /// @@ -137,7 +143,7 @@ public record PostCorehrV1JobChangesResponseDtoTransferInfo public bool? ProbationExist { get; set; } /// - /// 原部门 + /// 原部门,可通过[【批量查询部门】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/department/batch_get)接口获取 /// 必填:否 /// 示例值:6966236933198579208 /// @@ -145,7 +151,7 @@ public record PostCorehrV1JobChangesResponseDtoTransferInfo public string? OriginalDepartment { get; set; } /// - /// 新部门 + /// 新部门,可通过[【批量查询部门】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/department/batch_get)接口获取 /// 必填:否 /// 示例值:6966236933198579208 /// @@ -153,7 +159,7 @@ public record PostCorehrV1JobChangesResponseDtoTransferInfo public string? TargetDepartment { get; set; } /// - /// 原工作地点 + /// 原工作地点,可通过[【批量查询地点】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/location/list)接口获取 /// 必填:否 /// 示例值:6967271100992587295 /// @@ -161,7 +167,7 @@ public record PostCorehrV1JobChangesResponseDtoTransferInfo public string? OriginalWorkLocation { get; set; } /// - /// 新工作地点 + /// 新工作地点,可通过[【批量查询地点】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/location/list)接口获取 /// 必填:否 /// 示例值:6967271100992587295 /// @@ -169,7 +175,7 @@ public record PostCorehrV1JobChangesResponseDtoTransferInfo public string? TargetWorkLocation { get; set; } /// - /// 原直属上级 + /// 原直属上级,可通过[【搜索员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/search)接口获取 /// 必填:否 /// 示例值:6974641477444060708 /// @@ -177,7 +183,7 @@ public record PostCorehrV1JobChangesResponseDtoTransferInfo public string? OriginalDirectManager { get; set; } /// - /// 新直属上级 + /// 新直属上级,可通过[【搜索员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/search)接口获取 /// 必填:否 /// 示例值:7013619729281713671 /// @@ -185,7 +191,7 @@ public record PostCorehrV1JobChangesResponseDtoTransferInfo public string? TargetDirectManager { get; set; } /// - /// 原虚线上级 + /// 原虚线上级,可通过[【搜索员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/search)接口获取 /// 必填:否 /// 示例值:6974648866876573198 /// @@ -193,7 +199,7 @@ public record PostCorehrV1JobChangesResponseDtoTransferInfo public string? OriginalDottedManager { get; set; } /// - /// 新虚线上级 + /// 新虚线上级,可通过[【搜索员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/search)接口获取 /// 必填:否 /// 示例值:7013328578351842852 /// @@ -202,6 +208,7 @@ public record PostCorehrV1JobChangesResponseDtoTransferInfo /// /// 原职务 + /// 可通过[【批量查询职务】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job/list)接口获取 /// 必填:否 /// 示例值:6969469398088287751 /// @@ -210,6 +217,7 @@ public record PostCorehrV1JobChangesResponseDtoTransferInfo /// /// 新职务 + /// 可通过[【批量查询职务】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job/list)接口获取 /// 必填:否 /// 示例值:6969469557836760606 /// @@ -217,7 +225,7 @@ public record PostCorehrV1JobChangesResponseDtoTransferInfo public string? TargetJob { get; set; } /// - /// 原序列 + /// 原序列,可通过[【批量查询序列】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_family/list)接口获取 /// 必填:否 /// 示例值:6967287547462419975 /// @@ -225,7 +233,7 @@ public record PostCorehrV1JobChangesResponseDtoTransferInfo public string? OriginalJobFamily { get; set; } /// - /// 新序列 + /// 新序列,可通过[【批量查询序列】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_family/list)接口获取 /// 必填:否 /// 示例值:6967287547462419975 /// @@ -234,6 +242,7 @@ public record PostCorehrV1JobChangesResponseDtoTransferInfo /// /// 原级别 + /// 可通过[【批量查询职级】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_level/list)接口获取 /// 必填:否 /// 示例值:6972085707674355214 /// @@ -241,7 +250,8 @@ public record PostCorehrV1JobChangesResponseDtoTransferInfo public string? OriginalJobLevel { get; set; } /// - /// 新级别 + /// 新职级 + /// 可通过[【批量查询职级】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_level/list)接口获取 /// 必填:否 /// 示例值:6972085707674355214 /// @@ -249,7 +259,7 @@ public record PostCorehrV1JobChangesResponseDtoTransferInfo public string? TargetJobLevel { get; set; } /// - /// 原人员类型 + /// 原人员类型,可通过[【批量查询人员类型】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/employee_type/list)接口获取 /// 必填:否 /// 示例值:6968386026792289828 /// @@ -257,7 +267,7 @@ public record PostCorehrV1JobChangesResponseDtoTransferInfo public string? OriginalWorkforceType { get; set; } /// - /// 新人员类型 + /// 新人员类型,可通过[【批量查询人员类型】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/employee_type/list)接口获取 /// 必填:否 /// 示例值:7036268995372303885 /// @@ -265,7 +275,7 @@ public record PostCorehrV1JobChangesResponseDtoTransferInfo public string? TargetWorkforceType { get; set; } /// - /// 原公司 + /// 原公司,详细信息可通过[【批量查询公司】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/company/list)接口查询获得 /// 必填:否 /// 示例值:6974659700705068581 /// @@ -273,7 +283,7 @@ public record PostCorehrV1JobChangesResponseDtoTransferInfo public string? OriginalCompany { get; set; } /// - /// 新公司 + /// 新公司,详细信息可通过[【批量查询公司】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/company/list)接口查询获得 /// 必填:否 /// 示例值:6974659700705068581 /// @@ -281,7 +291,7 @@ public record PostCorehrV1JobChangesResponseDtoTransferInfo public string? TargetCompany { get; set; } /// - /// 原合同编号 + /// 原合同编号,可通过[【批量查询合同】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/contract/list)接口获取详细信息 /// 必填:否 /// 示例值:55332 /// @@ -289,7 +299,7 @@ public record PostCorehrV1JobChangesResponseDtoTransferInfo public string? OriginalContractNumber { get; set; } /// - /// 新合同编号 + /// 新合同编号,可通过[【批量查询合同】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/contract/list)接口获取详细信息 /// 必填:否 /// 示例值:55333 /// @@ -297,7 +307,7 @@ public record PostCorehrV1JobChangesResponseDtoTransferInfo public string? TargetContractNumber { get; set; } /// - /// 原合同类型 + /// 原合同类型,可通过[【批量查询合同】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/contract/list)接口获取详细信息 /// 必填:否 /// 示例值:labor_contract /// @@ -305,7 +315,7 @@ public record PostCorehrV1JobChangesResponseDtoTransferInfo public string? OriginalContractType { get; set; } /// - /// 新合同类型 + /// 新合同类型,可通过[【批量查询合同】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/contract/list)接口获取详细信息 /// 必填:否 /// 示例值:labor_contract /// @@ -313,7 +323,7 @@ public record PostCorehrV1JobChangesResponseDtoTransferInfo public string? TargetContractType { get; set; } /// - /// 原期限类型 + /// 原期限类型,可通过[【批量查询合同】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/contract/list)接口获取详细信息 /// 必填:否 /// 示例值:fixed_term /// @@ -321,7 +331,7 @@ public record PostCorehrV1JobChangesResponseDtoTransferInfo public string? OriginalDurationType { get; set; } /// - /// 新期限类型 + /// 新期限类型,可通过[【批量查询合同】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/contract/list)接口获取详细信息 /// 必填:否 /// 示例值:fixed_term /// @@ -329,7 +339,7 @@ public record PostCorehrV1JobChangesResponseDtoTransferInfo public string? TargetDurationType { get; set; } /// - /// 原签订类型 + /// 原签订类型,可通过[【批量查询合同】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/contract/list)接口获取详细信息 /// 必填:否 /// 示例值:new /// @@ -337,7 +347,7 @@ public record PostCorehrV1JobChangesResponseDtoTransferInfo public string? OriginalSigningType { get; set; } /// - /// 新签订类型 + /// 新签订类型,可通过[【批量查询合同】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/contract/list)接口获取详细信息 /// 必填:否 /// 示例值:new /// @@ -345,7 +355,7 @@ public record PostCorehrV1JobChangesResponseDtoTransferInfo public string? TargetSigningType { get; set; } /// - /// 原合同开始日期 + /// 原合同开始日期,格式:"YYYY-MM-DD" /// 必填:否 /// 示例值:2021-07-01 /// @@ -353,7 +363,7 @@ public record PostCorehrV1JobChangesResponseDtoTransferInfo public string? OriginalContractStartDate { get; set; } /// - /// 新合同开始日期 + /// 新合同开始日期,格式:"YYYY-MM-DD" /// 必填:否 /// 示例值:2021-07-01 /// @@ -361,7 +371,7 @@ public record PostCorehrV1JobChangesResponseDtoTransferInfo public string? TargetContractStartDate { get; set; } /// - /// 原合同结束日期 + /// 原合同结束日期,格式:"YYYY-MM-DD" /// 必填:否 /// 示例值:2024-07-01 /// @@ -369,7 +379,7 @@ public record PostCorehrV1JobChangesResponseDtoTransferInfo public string? OriginalContractEndDate { get; set; } /// - /// 新合同结束日期 + /// 新合同结束日期,格式:"YYYY-MM-DD" /// 必填:否 /// 示例值:2024-07-01 /// @@ -377,7 +387,7 @@ public record PostCorehrV1JobChangesResponseDtoTransferInfo public string? TargetContractEndDate { get; set; } /// - /// 原工时制度 + /// 原工时制度,可通过[【批量查询工时制度】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/working_hours_type/list)接口获取 /// 必填:否 /// 示例值:6969087376740206087 /// @@ -385,7 +395,7 @@ public record PostCorehrV1JobChangesResponseDtoTransferInfo public string? OriginalWorkingHoursType { get; set; } /// - /// 新工时制度 + /// 新工时制度,可通过[【批量查询工时制度】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/working_hours_type/list)接口获取 /// 必填:否 /// 示例值:6969087376740206087 /// @@ -393,7 +403,7 @@ public record PostCorehrV1JobChangesResponseDtoTransferInfo public string? TargetWorkingHoursType { get; set; } /// - /// 原工作日历 + /// 原工作日历,请开通休假服务后联系管理员获取工作日历数据 /// 必填:否 /// 示例值:6969087376740236087 /// @@ -401,7 +411,7 @@ public record PostCorehrV1JobChangesResponseDtoTransferInfo public string? OriginalWorkingCalendar { get; set; } /// - /// 新工作日历 + /// 新工作日历,请开通休假服务后联系管理员获取工作日历数据 /// 必填:否 /// 示例值:6969087376740236087 /// @@ -409,7 +419,7 @@ public record PostCorehrV1JobChangesResponseDtoTransferInfo public string? TargetWorkingCalendar { get; set; } /// - /// 原试用期预计结束日期 + /// 原试用期预计结束日期,格式:"YYYY-MM-DD" /// 必填:否 /// 示例值:2021-11-17 /// @@ -417,7 +427,7 @@ public record PostCorehrV1JobChangesResponseDtoTransferInfo public string? OriginalProbationEndDate { get; set; } /// - /// 新试用期预计结束日期 + /// 新试用期预计结束日期,格式:"YYYY-MM-DD" /// 必填:否 /// 示例值:2021-11-17 /// @@ -469,7 +479,7 @@ public record PostCorehrV1JobChangesResponseDtoTransferInfo public record SupportCostCenterItem { /// - /// 支持的成本中心id + /// 支持的成本中心id,详细信息可通过[【搜索成本中心信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/cost_center/search)接口查询获得 /// 必填:否 /// 示例值:6950635856373745165 /// @@ -491,5 +501,179 @@ public record SupportCostCenterItem /// [JsonPropertyName("target_cost_center_rate")] public SupportCostCenterItem[]? TargetCostCenterRates { get; set; } + + /// + /// 原工作信息 + /// 必填:否 + /// + [JsonPropertyName("original_employment_change")] + public TranferEmploymentInfo? OriginalEmploymentChange { get; set; } + + /// + /// 原工作信息 + /// + public record TranferEmploymentInfo + { + /// + /// 转正式员工日期,格式:"YYYY-MM-DD" + /// 必填:否 + /// 示例值:2023-01-01 + /// + [JsonPropertyName("regular_employee_start_date")] + public string? RegularEmployeeStartDate { get; set; } + + /// + /// 司龄起算日期,格式:"YYYY-MM-DD" + /// 必填:否 + /// 示例值:2023-01-01 + /// + [JsonPropertyName("seniority_date")] + public string? SeniorityDate { get; set; } + + /// + /// 员工编号,可通过[【搜索员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/search)接口获取 + /// 必填:否 + /// 示例值:1111111 + /// + [JsonPropertyName("employee_number")] + public string? EmployeeNumber { get; set; } + + /// + /// 自定义字段 + /// 必填:否 + /// + [JsonPropertyName("custom_fields")] + public CustomFieldData[]? CustomFields { get; set; } + + /// + /// 自定义字段 + /// + public record CustomFieldData + { + /// + /// 自定义字段 apiname,即自定义字段的唯一标识 + /// 必填:是 + /// 示例值:name + /// + [JsonPropertyName("custom_api_name")] + public string CustomApiName { get; set; } = string.Empty; + + /// + /// 自定义字段名称 + /// 必填:否 + /// + [JsonPropertyName("name")] + public CustomName? Name { get; set; } + + /// + /// 自定义字段名称 + /// + public record CustomName + { + /// + /// 中文 + /// 必填:否 + /// 示例值:自定义姓名 + /// + [JsonPropertyName("zh_cn")] + public string? ZhCn { get; set; } + + /// + /// 英文 + /// 必填:否 + /// 示例值:Custom Name + /// + [JsonPropertyName("en_us")] + public string? EnUs { get; set; } + } + + /// + /// 自定义字段类型 + /// 必填:否 + /// 示例值:1 + /// + [JsonPropertyName("type")] + public int? Type { get; set; } + + /// + /// 字段值,是 json 转义后的字符串,根据元数据定义不同,字段格式不同(如 123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05") + /// 必填:是 + /// 示例值:231 + /// + [JsonPropertyName("value")] + public string Value { get; set; } = string.Empty; + } + } + + /// + /// 新工作信息 + /// 必填:否 + /// + [JsonPropertyName("target_employment_change")] + public TranferEmploymentInfo? TargetEmploymentChange { get; set; } + + /// + /// 原职等,可通过[【查询职等】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job_grade/query)接口获取 + /// 必填:否 + /// 示例值:7289005963599693366 + /// + [JsonPropertyName("original_job_grade")] + public string? OriginalJobGrade { get; set; } + + /// + /// 新职等,可通过[【查询职等】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job_grade/query)接口获取 + /// 必填:否 + /// 示例值:7289005963599693366 + /// + [JsonPropertyName("target_job_grade")] + public string? TargetJobGrade { get; set; } + + /// + /// 原薪资类型,请开通薪酬服务后联系管理员获取 + /// 必填:否 + /// 示例值:hourly + /// + [JsonPropertyName("original_compensation_type")] + public string? OriginalCompensationType { get; set; } + + /// + /// 新薪资类型,请开通薪酬服务后联系管理员获取 + /// 必填:否 + /// 示例值:salary + /// + [JsonPropertyName("target_compensation_type")] + public string? TargetCompensationType { get; set; } + + /// + /// 原任职公司,详细信息可通过[【批量查询公司】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/company/list)接口查询获得 + /// 必填:否 + /// 示例值:7289005963599693367 + /// + [JsonPropertyName("original_service_company")] + public string? OriginalServiceCompany { get; set; } + + /// + /// 新任职公司,详细信息可通过[【批量查询公司】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/company/list)接口查询获得 + /// 必填:否 + /// 示例值:7289005963599693367 + /// + [JsonPropertyName("target_service_company")] + public string? TargetServiceCompany { get; set; } + + /// + /// 原岗位,可通过[【岗职务管理-岗位】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/position/query)相关API获取(目前仅灰度部分租户,如需要请联系管理员开灰) + /// 必填:否 + /// 示例值:7289005963599693367 + /// + [JsonPropertyName("original_position")] + public string? OriginalPosition { get; set; } + + /// + /// 新岗位,可通过[【岗职务管理-岗位】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/position/query)相关API获取(目前仅灰度部分租户,如需要请联系管理员开灰) + /// 必填:否 + /// 示例值:7289005963599693367 + /// + [JsonPropertyName("target_position")] + public string? TargetPosition { get; set; } } } diff --git a/src/FeishuPeople/PostCorehrV1OffboardingsQueryResponseDto.cs b/src/FeishuPeople/PostCorehrV1OffboardingsQueryResponseDto.cs index 6177f36a..b436a161 100644 --- a/src/FeishuPeople/PostCorehrV1OffboardingsQueryResponseDto.cs +++ b/src/FeishuPeople/PostCorehrV1OffboardingsQueryResponseDto.cs @@ -89,7 +89,7 @@ public record I18n public string? ParentOffboardingReasonUniqueIdentifier { get; set; } /// - /// 创建时间 + /// 创建时间,格式:"YYYY-MM-DD HH-mm-ss" /// 必填:否 /// 示例值:2021-08-20 20:28:23 /// @@ -97,7 +97,7 @@ public record I18n public string? CreatedTime { get; set; } /// - /// 更新时间 + /// 更新时间,格式:"YYYY-MM-DD HH-mm-ss" /// 必填:否 /// 示例值:2022-01-07 17:21:06 /// diff --git a/src/FeishuPeople/PostCorehrV1OffboardingsSearchBodyDto.cs b/src/FeishuPeople/PostCorehrV1OffboardingsSearchBodyDto.cs index b5baabf9..9b6b0b58 100644 --- a/src/FeishuPeople/PostCorehrV1OffboardingsSearchBodyDto.cs +++ b/src/FeishuPeople/PostCorehrV1OffboardingsSearchBodyDto.cs @@ -14,7 +14,7 @@ namespace FeishuNetSdk.FeishuPeople; /// /// 搜索离职信息 请求体 -/// 该接口支持员工ID、离职审批发起时间和离职日期等字段搜索离职信息,可获取包括离职日期、离职原因、离职状态和流程审批状态等信息。 +/// 该接口支持根据员工ID、离职审批发起时间和离职日期等字段搜索离职信息,可获取包括离职日期、离职原因、离职状态和流程审批状态等信息。 /// 接口ID:7211423970042183684 /// 文档地址:https://open.feishu.cn/document/server-docs/corehr-v1/offboarding/search /// JSON地址:https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fcorehr-v1%2foffboarding%2fsearch @@ -30,7 +30,7 @@ public record PostCorehrV1OffboardingsSearchBodyDto public string[]? EmploymentIds { get; set; } /// - /// 离职审批发起时间(搜索的起始范围),请按照秒级时间戳格式传入。该字段非必填,需要与搜索范围结束一同使用。 + /// 离职审批发起时间(搜索的起始范围),请按照秒级时间戳格式传入。该字段非必填,需要与离职审批发起时间(搜索的结束范围)一同使用。 /// 必填:否 /// 示例值:1672578336 /// @@ -38,7 +38,7 @@ public record PostCorehrV1OffboardingsSearchBodyDto public string? ApplyInitiatingTimeStart { get; set; } /// - /// 离职审批发起时间(搜索的结束范围),请按照秒级时间戳格式传入。该字段非必填,需要与搜索范围开始一同使用。 + /// 离职审批发起时间(搜索的结束范围),请按照秒级时间戳格式传入。该字段非必填,需要与离职审批发起时间(搜索的起始范围)一同使用。 /// 必填:否 /// 示例值:1674133537 /// @@ -46,7 +46,7 @@ public record PostCorehrV1OffboardingsSearchBodyDto public string? ApplyInitiatingTimeEnd { get; set; } /// - /// 期望离职日期(搜索的起始范围),请按日期格式传入。该字段非必填,需要与搜索范围结束一同使用 + /// 期望离职日期(搜索的起始范围),请按日期格式传入。该字段非必填,需要与期望离职日期(搜索的结束范围)一同使用 /// 必填:否 /// 示例值:2022-01-01 /// @@ -54,7 +54,7 @@ public record PostCorehrV1OffboardingsSearchBodyDto public string? ExpectedOffboardingDateStart { get; set; } /// - /// 期望离职日期(搜索的结束范围),请按日期格式传入。该字段非必填,需要与搜索范围开始一同使用。 + /// 期望离职日期(搜索的结束范围),请按日期格式传入。该字段非必填,需要与期望离职日期(搜索的起始范围)一同使用。 /// 必填:否 /// 示例值:2022-01-01 /// @@ -62,7 +62,7 @@ public record PostCorehrV1OffboardingsSearchBodyDto public string? ExpectedOffboardingDateEnd { get; set; } /// - /// 离职日期(搜索的起始范围),请按日期格式传入。该字段非必填,需要与搜索范围结束一同使用。 + /// 离职日期(搜索的起始范围),请按日期格式传入。该字段非必填,需要与离职日期(搜索的结束范围)一同使用。 /// 必填:否 /// 示例值:2022-01-01 /// @@ -70,7 +70,7 @@ public record PostCorehrV1OffboardingsSearchBodyDto public string? OffboardingDateStart { get; set; } /// - /// 离职日期(搜索的结束范围),该字段非必填,需要与搜索范围开始一同使用。 + /// 离职日期(搜索的结束范围),该字段非必填,需要与离职日期(搜索的起始范围)一同使用。 /// 必填:否 /// 示例值:2022-01-01 /// @@ -88,7 +88,7 @@ public record PostCorehrV1OffboardingsSearchBodyDto /// /// 离职原因列表 , 可以通过[【查询员工离职原因列表】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/offboarding/query)接口获取 ,查询时不返回下级原因相关的离职信息。为空时默认搜索所有离职数据。 /// 字段权限要求: - /// 按照离职原因搜索(corehr:employment.offboarding_reason.search:read) + /// <md-perm name="corehr:employment.offboarding_reason.search:read" desc="按照离职原因搜索" support_app_types="custom,isv" tags="">按照离职原因搜索</md-perm>corehr:employment.offboarding_reason.search:read,确认已开通该权限。 /// 必填:否 /// [JsonPropertyName("reasons")] @@ -97,7 +97,7 @@ public record PostCorehrV1OffboardingsSearchBodyDto /// /// 离职原因(员工)列表 , 可以通过[【查询员工离职原因列表】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/offboarding/query)接口获取,查询时不返回下级原因相关的离职信息。为空时默认搜索所有离职数据。 /// 字段权限要求: - /// 按照离职原因搜索(corehr:employment.offboarding_reason.search:read) + /// <md-perm name="corehr:employment.offboarding_reason.search:read" desc="按照离职原因搜索" support_app_types="custom,isv" tags="">按照离职原因搜索</md-perm> /// 必填:否 /// [JsonPropertyName("employee_reasons")] diff --git a/src/FeishuPeople/PostCorehrV1OffboardingsSearchResponseDto.cs b/src/FeishuPeople/PostCorehrV1OffboardingsSearchResponseDto.cs index 597d6ed3..31b91bdf 100644 --- a/src/FeishuPeople/PostCorehrV1OffboardingsSearchResponseDto.cs +++ b/src/FeishuPeople/PostCorehrV1OffboardingsSearchResponseDto.cs @@ -14,7 +14,7 @@ namespace FeishuNetSdk.FeishuPeople; /// /// 搜索离职信息 响应体 -/// 该接口支持员工ID、离职审批发起时间和离职日期等字段搜索离职信息,可获取包括离职日期、离职原因、离职状态和流程审批状态等信息。 +/// 该接口支持根据员工ID、离职审批发起时间和离职日期等字段搜索离职信息,可获取包括离职日期、离职原因、离职状态和流程审批状态等信息。 /// 接口ID:7211423970042183684 /// 文档地址:https://open.feishu.cn/document/server-docs/corehr-v1/offboarding/search /// JSON地址:https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fcorehr-v1%2foffboarding%2fsearch @@ -232,7 +232,11 @@ public record I18n public string? AddBlockList { get; set; } /// - /// 屏蔽原因 + /// 屏蔽原因,枚举值可查询 + /// [【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口获取,按如下参数查 + /// 询即可: + /// object_api_name= "offboarding_info" + /// custom_api_name= "block_reason" /// 必填:否 /// [JsonPropertyName("block_reason")] diff --git a/src/FeishuPeople/PostCorehrV1OffboardingsSubmitBodyDto.cs b/src/FeishuPeople/PostCorehrV1OffboardingsSubmitBodyDto.cs index 7f701ac9..72c5b264 100644 --- a/src/FeishuPeople/PostCorehrV1OffboardingsSubmitBodyDto.cs +++ b/src/FeishuPeople/PostCorehrV1OffboardingsSubmitBodyDto.cs @@ -14,7 +14,7 @@ namespace FeishuNetSdk.FeishuPeople; /// /// 操作员工离职 请求体 -/// 该接口用于发起员工离职,相当于人事系统员工的直接离职功能。若发起成功,会生成一条员工的离职数据,同时产生相应的事件。参考[离职申请状态变更(新)](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/offboarding/events/status_updated)和[离职流转状态变更](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/offboarding/events/checklist_updated) +/// 该接口用于发起员工离职。若发起成功,会生成一条员工的离职数据,同时产生相应的事件。参考[离职申请状态变更](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/offboarding/events/status_updated) /// 接口ID:7097044451155214340 /// 文档地址:https://open.feishu.cn/document/server-docs/corehr-v1/offboarding/submit /// JSON地址:https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fcorehr-v1%2foffboarding%2fsubmit diff --git a/src/FeishuPeople/PostCorehrV1OffboardingsSubmitResponseDto.cs b/src/FeishuPeople/PostCorehrV1OffboardingsSubmitResponseDto.cs index 29eb8366..299bcc8e 100644 --- a/src/FeishuPeople/PostCorehrV1OffboardingsSubmitResponseDto.cs +++ b/src/FeishuPeople/PostCorehrV1OffboardingsSubmitResponseDto.cs @@ -14,7 +14,7 @@ namespace FeishuNetSdk.FeishuPeople; /// /// 操作员工离职 响应体 -/// 该接口用于发起员工离职,相当于人事系统员工的直接离职功能。若发起成功,会生成一条员工的离职数据,同时产生相应的事件。参考[离职申请状态变更(新)](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/offboarding/events/status_updated)和[离职流转状态变更](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/offboarding/events/checklist_updated) +/// 该接口用于发起员工离职。若发起成功,会生成一条员工的离职数据,同时产生相应的事件。参考[离职申请状态变更](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/offboarding/events/status_updated) /// 接口ID:7097044451155214340 /// 文档地址:https://open.feishu.cn/document/server-docs/corehr-v1/offboarding/submit /// JSON地址:https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fcorehr-v1%2foffboarding%2fsubmit diff --git a/src/Hire/GetHireV1ResumeSourcesResponseDto.cs b/src/Hire/GetHireV1ResumeSourcesResponseDto.cs index 57242255..d1efa8ba 100644 --- a/src/Hire/GetHireV1ResumeSourcesResponseDto.cs +++ b/src/Hire/GetHireV1ResumeSourcesResponseDto.cs @@ -34,15 +34,15 @@ public record GetHireV1ResumeSourcesResponseDto public record ResumeSource { /// - /// 来源 ID + /// 简历来源 ID /// 必填:否 - /// 示例值:1111 + /// 示例值:10000 /// [JsonPropertyName("id")] public string? Id { get; set; } /// - /// 中文名 + /// 简历来源中文名称 /// 必填:否 /// 示例值:内推 /// @@ -50,7 +50,7 @@ public record ResumeSource public string? ZhName { get; set; } /// - /// 英文名 + /// 简历来源英文名称 /// 必填:否 /// 示例值:referral /// @@ -72,7 +72,7 @@ public record ResumeSource /// /// 来源类型 /// 必填:否 - /// 示例值:1 + /// 示例值:10001 /// 可选值: /// 10000:内推 /// 10001:猎头 diff --git a/src/Hire/GetHireV1WebsitesByWebsiteIdChannelsResponseDto.cs b/src/Hire/GetHireV1WebsitesByWebsiteIdChannelsResponseDto.cs index ff3a2dd3..d6b4333d 100644 --- a/src/Hire/GetHireV1WebsitesByWebsiteIdChannelsResponseDto.cs +++ b/src/Hire/GetHireV1WebsitesByWebsiteIdChannelsResponseDto.cs @@ -14,7 +14,7 @@ namespace FeishuNetSdk.Hire; /// /// 获取招聘官网推广渠道列表 响应体 -/// 根据官网 ID 分页获取推广渠道列表。 +/// 根据官网 ID 获取推广渠道列表,支持分页查询。 /// 接口ID:7097130725263441921 /// 文档地址:https://open.feishu.cn/document/server-docs/hire-v1/get-candidates/website/list-3 /// JSON地址:https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fukTMukTMukTM%2fuMzM1YjLzMTN24yMzUjN%2fhire-v1%2fwebsite-channel%2flist @@ -60,7 +60,7 @@ public record WebsiteChannelInfo /// /// 推广渠道名称 /// 必填:否 - /// 示例值:官网 + /// 示例值:微信推广渠道 /// [JsonPropertyName("name")] public string? Name { get; set; } diff --git a/src/Hire/GetHireV1WebsitesResponseDto.cs b/src/Hire/GetHireV1WebsitesResponseDto.cs new file mode 100644 index 00000000..76358e1d --- /dev/null +++ b/src/Hire/GetHireV1WebsitesResponseDto.cs @@ -0,0 +1,106 @@ +// ************************************************************************ +// Assembly : FeishuNetSdk +// Author : yxr +// Created : 2024-07-18 +// +// Last Modified By : yxr +// Last Modified On : 2024-07-18 +// ************************************************************************ +// +// MIT +// +// 获取招聘官网列表 响应体 +// ************************************************************************ +namespace FeishuNetSdk.Hire; +/// +/// 获取招聘官网列表 响应体 +/// 获取招聘官网列表,返回信息包括官网名称、官网ID、职位渠道ID等。 +/// 接口ID:6990661791098699779 +/// 文档地址:https://open.feishu.cn/document/server-docs/hire-v1/get-candidates/website/list +/// JSON地址:https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fukTMukTMukTM%2fuMzM1YjLzMTN24yMzUjN%2fhire-v1%2fwebsite%2flist +/// +public record GetHireV1WebsitesResponseDto +{ + /// + /// 官网列表 + /// 必填:否 + /// + [JsonPropertyName("items")] + public Website[]? Items { get; set; } + + /// + /// 官网列表 + /// + public record Website + { + /// + /// 官网ID + /// 必填:否 + /// 示例值:1213213123123 + /// + [JsonPropertyName("id")] + public string? Id { get; set; } + + /// + /// 官网名称 + /// 必填:否 + /// + [JsonPropertyName("name")] + public I18n? Name { get; set; } + + /// + /// 官网名称 + /// + public record I18n + { + /// + /// 官网中文名称 + /// 必填:否 + /// 示例值:校招官网 + /// + [JsonPropertyName("zh_cn")] + public string? ZhCn { get; set; } + + /// + /// 官网英文名称 + /// 必填:否 + /// 示例值:campus recruitment site + /// + [JsonPropertyName("en_us")] + public string? EnUs { get; set; } + } + + /// + /// 流程类型 + /// - 1: 社招 + /// - 2: 校招 + /// 必填:否 + /// + [JsonPropertyName("process_type_list")] + public int[]? ProcessTypeList { get; set; } + + /// + /// 职位渠道ID,每个官网拥有唯一的职位渠道ID,可用于[职位发布至官网](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/advertisement/publish) + /// 必填:否 + /// 示例值:1213213123123 + /// + [JsonPropertyName("job_channel_id")] + public string? JobChannelId { 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/PostHireV1AdvertisementsByAdvertisementIdPublishBodyDto.cs b/src/Hire/PostHireV1AdvertisementsByAdvertisementIdPublishBodyDto.cs new file mode 100644 index 00000000..aa13aa6e --- /dev/null +++ b/src/Hire/PostHireV1AdvertisementsByAdvertisementIdPublishBodyDto.cs @@ -0,0 +1,31 @@ +// ************************************************************************ +// Assembly : FeishuNetSdk +// Author : yxr +// Created : 2024-07-18 +// +// Last Modified By : yxr +// Last Modified On : 2024-07-18 +// ************************************************************************ +// +// MIT +// +// 职位发布至官网 请求体 +// ************************************************************************ +namespace FeishuNetSdk.Hire; +/// +/// 职位发布至官网 请求体 +/// 支持把职位发布至招聘官网、内推平台。 +/// 接口ID:7012986483075547137 +/// 文档地址:https://open.feishu.cn/document/server-docs/hire-v1/recruitment-related-configuration/job/publish +/// JSON地址:https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fukTMukTMukTM%2fuMzM1YjLzMTN24yMzUjN%2fhire-v1%2fadvertisement%2fpublish +/// +public record PostHireV1AdvertisementsByAdvertisementIdPublishBodyDto +{ + /// + /// 职位渠道 ID,选择要发布的招聘官网,单次仅可发布 1 个渠道,1. 内推平台提供对应的 id = 3,2. 官网渠道的 ID 通过接口「获取官网列表」获取 + /// 必填:否 + /// 示例值:6960663240925956631 + /// + [JsonPropertyName("job_channel_id")] + public string? JobChannelId { get; set; } +} diff --git a/src/Hire/PostHireV1WebsitesByWebsiteIdChannelsBodyDto.cs b/src/Hire/PostHireV1WebsitesByWebsiteIdChannelsBodyDto.cs index 38a4529d..fb5d5497 100644 --- a/src/Hire/PostHireV1WebsitesByWebsiteIdChannelsBodyDto.cs +++ b/src/Hire/PostHireV1WebsitesByWebsiteIdChannelsBodyDto.cs @@ -14,7 +14,7 @@ namespace FeishuNetSdk.Hire; /// /// 新建招聘官网推广渠道 请求体 -/// 根据招聘官网 ID 和推广渠道名称创建招聘官网推广渠道。 +/// 新建指定官网的推广渠道。每个官网可以新建多个推广渠道,每个推广渠道具有不同的推广链接和推广码。 /// 接口ID:7097130725263474689 /// 文档地址:https://open.feishu.cn/document/server-docs/hire-v1/get-candidates/website/create-2 /// JSON地址:https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fukTMukTMukTM%2fuMzM1YjLzMTN24yMzUjN%2fhire-v1%2fwebsite-channel%2fcreate @@ -24,7 +24,7 @@ public record PostHireV1WebsitesByWebsiteIdChannelsBodyDto /// /// 推广渠道名称 /// 必填:是 - /// 示例值:小爱侧推广渠道 + /// 示例值:微信推广渠道 /// [JsonPropertyName("channel_name")] public string ChannelName { get; set; } = string.Empty; diff --git a/src/Hire/PostHireV1WebsitesByWebsiteIdChannelsResponseDto.cs b/src/Hire/PostHireV1WebsitesByWebsiteIdChannelsResponseDto.cs index 68d6b75a..e6fb374c 100644 --- a/src/Hire/PostHireV1WebsitesByWebsiteIdChannelsResponseDto.cs +++ b/src/Hire/PostHireV1WebsitesByWebsiteIdChannelsResponseDto.cs @@ -14,7 +14,7 @@ namespace FeishuNetSdk.Hire; /// /// 新建招聘官网推广渠道 响应体 -/// 根据招聘官网 ID 和推广渠道名称创建招聘官网推广渠道。 +/// 新建指定官网的推广渠道。每个官网可以新建多个推广渠道,每个推广渠道具有不同的推广链接和推广码。 /// 接口ID:7097130725263474689 /// 文档地址:https://open.feishu.cn/document/server-docs/hire-v1/get-candidates/website/create-2 /// JSON地址:https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fukTMukTMukTM%2fuMzM1YjLzMTN24yMzUjN%2fhire-v1%2fwebsite-channel%2fcreate @@ -32,7 +32,7 @@ public record PostHireV1WebsitesByWebsiteIdChannelsResponseDto /// /// 推广渠道名称 /// 必填:否 - /// 示例值:官网 + /// 示例值:官网微信渠道 /// [JsonPropertyName("name")] public string? Name { get; set; } diff --git a/src/Hire/PostHireV1WebsitesByWebsiteIdSiteUsersBodyDto.cs b/src/Hire/PostHireV1WebsitesByWebsiteIdSiteUsersBodyDto.cs new file mode 100644 index 00000000..37ba71c0 --- /dev/null +++ b/src/Hire/PostHireV1WebsitesByWebsiteIdSiteUsersBodyDto.cs @@ -0,0 +1,63 @@ +// ************************************************************************ +// Assembly : FeishuNetSdk +// Author : yxr +// Created : 2024-07-18 +// +// Last Modified By : yxr +// Last Modified On : 2024-07-18 +// ************************************************************************ +// +// MIT +// +// 新建招聘官网用户 请求体 +// ************************************************************************ +namespace FeishuNetSdk.Hire; +/// +/// 新建招聘官网用户 请求体 +/// 注册指定招聘官网的用户,注册完成后,可通过[创建招聘官网投递任务](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/website-delivery/create_by_attachment)创建官网投递任务,或通过[新建招聘官网投递](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/website-delivery/create_by_resume)创建官网投递 +/// 接口ID:6990661791098634243 +/// 文档地址:https://open.feishu.cn/document/server-docs/hire-v1/get-candidates/website/create +/// JSON地址:https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fukTMukTMukTM%2fuMzM1YjLzMTN24yMzUjN%2fhire-v1%2fwebsite-site_user%2fcreate +/// +public record PostHireV1WebsitesByWebsiteIdSiteUsersBodyDto +{ + /// + /// 用户姓名 + /// 必填:否 + /// 示例值:张敏 + /// + [JsonPropertyName("name")] + public string? Name { get; set; } + + /// + /// 用户邮箱 + /// 必填:否 + /// 示例值:zhangmin@163.com + /// + [JsonPropertyName("email")] + public string? Email { get; set; } + + /// + /// 外部 ID,幂等字段,同一外部 ID只会创建1个官网用户;当系统中已存在`external_id`对应的官网用户时,接口会返回已存在的官网用户信息 + /// 必填:是 + /// 示例值:6960663240925956621 + /// + [JsonPropertyName("external_id")] + public string ExternalId { get; set; } = string.Empty; + + /// + /// 电话,若填写了该字段,国家码(mobile_country_code)字段必填 + /// 必填:否 + /// 示例值:182900291190 + /// + [JsonPropertyName("mobile")] + public string? Mobile { get; set; } + + /// + /// 国家码,若填写了该字段,电话(mobile)字段必填,可通过[获取地点列表](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/location/query)获取 + /// 必填:否 + /// 示例值:CN_1 + /// + [JsonPropertyName("mobile_country_code")] + public string? MobileCountryCode { get; set; } +} diff --git a/src/Hire/PostHireV1WebsitesByWebsiteIdSiteUsersResponseDto.cs b/src/Hire/PostHireV1WebsitesByWebsiteIdSiteUsersResponseDto.cs new file mode 100644 index 00000000..4b8b9de4 --- /dev/null +++ b/src/Hire/PostHireV1WebsitesByWebsiteIdSiteUsersResponseDto.cs @@ -0,0 +1,84 @@ +// ************************************************************************ +// Assembly : FeishuNetSdk +// Author : yxr +// Created : 2024-07-18 +// +// Last Modified By : yxr +// Last Modified On : 2024-07-18 +// ************************************************************************ +// +// MIT +// +// 新建招聘官网用户 响应体 +// ************************************************************************ +namespace FeishuNetSdk.Hire; +/// +/// 新建招聘官网用户 响应体 +/// 注册指定招聘官网的用户,注册完成后,可通过[创建招聘官网投递任务](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/website-delivery/create_by_attachment)创建官网投递任务,或通过[新建招聘官网投递](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/website-delivery/create_by_resume)创建官网投递 +/// 接口ID:6990661791098634243 +/// 文档地址:https://open.feishu.cn/document/server-docs/hire-v1/get-candidates/website/create +/// JSON地址:https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fukTMukTMukTM%2fuMzM1YjLzMTN24yMzUjN%2fhire-v1%2fwebsite-site_user%2fcreate +/// +public record PostHireV1WebsitesByWebsiteIdSiteUsersResponseDto +{ + /// + /// 官网用户信息 + /// 必填:否 + /// + [JsonPropertyName("site_user")] + public WebsiteUser? SiteUser { get; set; } + + /// + /// 官网用户信息 + /// + public record WebsiteUser + { + /// + /// 官网用户 ID + /// 必填:否 + /// 示例值:6960663240925956620 + /// + [JsonPropertyName("user_id")] + public string? UserId { get; set; } + + /// + /// 用户姓名 + /// 必填:否 + /// 示例值:dan27 + /// + [JsonPropertyName("name")] + public string? Name { get; set; } + + /// + /// 用户邮箱 + /// 必填:否 + /// 示例值:dan27@163.com + /// + [JsonPropertyName("email")] + public string? Email { get; set; } + + /// + /// 外部 ID + /// 必填:是 + /// 示例值:6960663240925956621 + /// + [JsonPropertyName("external_id")] + public string ExternalId { get; set; } = string.Empty; + + /// + /// 电话 + /// 必填:否 + /// 示例值:182900291190 + /// + [JsonPropertyName("mobile")] + public string? Mobile { get; set; } + + /// + /// 国家码 + /// 必填:否 + /// 示例值:CN_1 + /// + [JsonPropertyName("mobile_country_code")] + public string? MobileCountryCode { get; set; } + } +} diff --git a/src/Hire/PutHireV1WebsitesByWebsiteIdChannelsByChannelIdBodyDto.cs b/src/Hire/PutHireV1WebsitesByWebsiteIdChannelsByChannelIdBodyDto.cs index 58e0e476..2fa7b1b7 100644 --- a/src/Hire/PutHireV1WebsitesByWebsiteIdChannelsByChannelIdBodyDto.cs +++ b/src/Hire/PutHireV1WebsitesByWebsiteIdChannelsByChannelIdBodyDto.cs @@ -14,7 +14,7 @@ namespace FeishuNetSdk.Hire; /// /// 更新招聘官网推广渠道 请求体 -/// 根据招聘官网 ID 和推广渠道 ID 更改推广渠道名称。 +/// 根据招聘官网 ID 和推广渠道 ID 更改推广渠道,仅支持修改推广渠道名称。 /// 接口ID:7097130725263491073 /// 文档地址:https://open.feishu.cn/document/server-docs/hire-v1/get-candidates/website/update /// JSON地址:https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fukTMukTMukTM%2fuMzM1YjLzMTN24yMzUjN%2fhire-v1%2fwebsite-channel%2fupdate @@ -24,7 +24,7 @@ public record PutHireV1WebsitesByWebsiteIdChannelsByChannelIdBodyDto /// /// 推广渠道名称 /// 必填:是 - /// 示例值:小爱侧推广渠道 + /// 示例值:微信推广渠道 /// [JsonPropertyName("channel_name")] public string ChannelName { get; set; } = string.Empty; diff --git a/src/Hire/PutHireV1WebsitesByWebsiteIdChannelsByChannelIdResponseDto.cs b/src/Hire/PutHireV1WebsitesByWebsiteIdChannelsByChannelIdResponseDto.cs index 51290d7b..0832f5eb 100644 --- a/src/Hire/PutHireV1WebsitesByWebsiteIdChannelsByChannelIdResponseDto.cs +++ b/src/Hire/PutHireV1WebsitesByWebsiteIdChannelsByChannelIdResponseDto.cs @@ -14,7 +14,7 @@ namespace FeishuNetSdk.Hire; /// /// 更新招聘官网推广渠道 响应体 -/// 根据招聘官网 ID 和推广渠道 ID 更改推广渠道名称。 +/// 根据招聘官网 ID 和推广渠道 ID 更改推广渠道,仅支持修改推广渠道名称。 /// 接口ID:7097130725263491073 /// 文档地址:https://open.feishu.cn/document/server-docs/hire-v1/get-candidates/website/update /// JSON地址:https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fukTMukTMukTM%2fuMzM1YjLzMTN24yMzUjN%2fhire-v1%2fwebsite-channel%2fupdate @@ -32,7 +32,7 @@ public record PutHireV1WebsitesByWebsiteIdChannelsByChannelIdResponseDto /// /// 推广渠道名称 /// 必填:否 - /// 示例值:官网 + /// 示例值:微信推广渠道 /// [JsonPropertyName("name")] public string? Name { get; set; } diff --git a/src/IFeishuTenantApi.cs b/src/IFeishuTenantApi.cs index 42c8047e..9a0fef7a 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-07-15 +// Last Modified On : 2024-07-18 // ************************************************************************ // // MIT @@ -205,6 +205,8 @@ System.Threading.Tasks.Task PostInteractiveV1CardUpdateAsync( /// 接口文档:https://open.feishu.cn/document/ukTMukTMukTM/ukjMzUjL5IzM14SOyMTN /// Authorization:tenant_access_token、user_access_token /// 设置单元格中数据的样式。支持设置字体、背景、边框等样式。 + /// 使用限制:- 单次设置的范围不可超过 5,000 行 100 列。 + /// - 在设置边框样式时,单次更新的单元格数量不可超过 30,000 个。 /// 权限要求: /// drive:drive /// sheets:spreadsheet @@ -557,6 +559,8 @@ System.Threading.Tasks.Task PostApprovalOpenapiV2InstanceTransfe /// 接口文档:https://open.feishu.cn/document/ukTMukTMukTM/uATNzUjLwUzM14CM1MTN /// Authorization:tenant_access_token、user_access_token /// 拆分电子表格工作表中的单元格。 + /// 使用限制: + /// 单次操作范围不可超过 5,000 行、100 列。 /// 权限要求: /// drive:drive /// sheets:spreadsheet @@ -581,6 +585,9 @@ System.Threading.Tasks.Task PostApprovalOpenapiV2InstanceTransfe /// 接口文档:https://open.feishu.cn/document/ukTMukTMukTM/ucjMzUjL3IzM14yNyMTN /// Authorization:tenant_access_token、user_access_token /// 该接口用于删除电子表格中的指定行或列。 + /// 使用限制: + /// - 单次调用该接口,最多支持删除 5000 行或列。 + /// - 一个工作表最少需有一行一列。你无法删除所有行或列。 /// 权限要求: /// drive:drive /// sheets:spreadsheet @@ -687,6 +694,9 @@ System.Threading.Tasks.Task PostMeetingRoomRoomUpdateAsync( /// 接口文档:https://open.feishu.cn/document/ukTMukTMukTM/uMjMzUjLzIzM14yMyMTN /// Authorization:tenant_access_token、user_access_token /// 在电子表格工作表的指定范围中,在空白位置中追加数据。例如,若指定范围参数 `range` 为 `6e5ed3!A1:B2`,该接口将会依次寻找 A1、A2、A3...单元格,在找到的第一个空白位置中写入数据。 + /// 使用限制: + /// - 单次写入范围不可超过 5,000 行、100 列。 + /// - 每个单元格不超过 50,000 字符,由于服务端会增加控制字符,因此推荐每个单元格不超过 40,000 字符。 /// 权限要求: /// drive:drive /// sheets:spreadsheet @@ -840,6 +850,7 @@ System.Threading.Tasks.Task PostMeetingRoomRoomUpdateAsync( /// 接口文档:https://open.feishu.cn/document/ukTMukTMukTM/uYjMzUjL2IzM14iNyMTN /// Authorization:tenant_access_token、user_access_token /// 该接口用于更新设置电子表格中行列的属性,包括是否隐藏行列和设置行高列宽。 + /// 使用限制:单次调用该接口,最多支持设置 5000 行或列。 /// 权限要求: /// drive:drive /// sheets:spreadsheet @@ -888,6 +899,10 @@ System.Threading.Tasks.Task PutSheetsV2SpreadsheetsBySpreadsheet /// 接口文档:https://open.feishu.cn/document/ukTMukTMukTM/uAzMzUjLwMzM14CMzMTN /// Authorization:tenant_access_token、user_access_token /// 批量设置单元格中数据的样式。支持设置字体、背景、边框等样式。 + /// 使用限制:- 单次设置的范围不可超过 5,000 行 100 列。 + /// - 在设置边框样式时,单次更新的单元格数量不可超过 30,000 个。 + /// 注意事项: + /// 在批量设置单元格时,当单元格在多个范围中时,单元格将应用请求体的最后一个样式。例如,对 A1:B2、B2:C3 分别设置样式,B2 单元格将应用 B2:C3 区域的样式。 /// 权限要求: /// drive:drive /// sheets:spreadsheet @@ -911,26 +926,34 @@ System.Threading.Tasks.Task PutSheetsV2SpreadsheetsBySpreadsheet /// 接口ID:6907569742383988738 /// 接口文档:https://open.feishu.cn/document/ukTMukTMukTM/ugDNzUjL4QzM14CO0MTN /// Authorization:tenant_access_token、user_access_token - /// 该接口用于根据 spreadsheetToken 和维度信息增加多个保护范围;单次操作不超过5000行或列。 - /// 仅支持设置保护行或保护列,暂不支持设置保护单元格 + /// 在电子表格工作表中设置多个保护范围,支持对行或列设置保护范围。 /// 权限要求: /// drive:drive /// sheets:spreadsheet /// /// - /// + /// /// 路径参数 /// 必填:是 - /// spreadsheet 的 token,获取方式见 [在线表格开发指南](https://open.feishu.cn/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/overview) + /// 电子表格的 token。可通过以下两种方式获取。了解更多,参考[电子表格概述](https://open.feishu.cn/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/overview)。 + /// - 电子表格的 URL:https://sample.feishu.cn/sheets/==Iow7sNNEphp3WbtnbCscPqabcef== + /// - 调用[获取文件夹中的文件清单](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/list) + /// **示例值**:"Iow7sNNEphp3WbtnbCscPqabcef" /// /// /// 必填:否 - /// 请求的用户id类型,可选open_id,union_id + /// 指定请求体中 users 字段对应的用户 ID 类型。可选值如下所示。了解更多,参考[用户身份概述](https://open.feishu.cn/document/home/user-identity-introduction/introduction)。可选值: + /// - `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) + /// **注意**: + /// 若要在请求体中传入 users 参数,user_id_type 参数必填。 /// 默认值:open_id /// - [HttpPost("/open-apis/sheets/v2/spreadsheets/{spreadsheetToken}/protected_dimension")] - System.Threading.Tasks.Task PostSheetsV2SpreadsheetsBySpreadsheetTokenProtectedDimensionAsync( - [PathQuery] string spreadsheetToken, + /// 请求体 + [HttpPost("/open-apis/sheets/v2/spreadsheets/{spreadsheet_token}/protected_dimension")] + System.Threading.Tasks.Task> PostSheetsV2SpreadsheetsBySpreadsheetTokenProtectedDimensionAsync( + [PathQuery] string spreadsheet_token, + [JsonContent] Ccm.Spec.PostSheetsV2SpreadsheetsBySpreadsheetTokenProtectedDimensionBodyDto dto, [PathQuery] string? user_id_type = "open_id"); /// @@ -1098,6 +1121,8 @@ System.Threading.Tasks.Task PostEphemeralV1DeleteAsync( /// 接口文档:https://open.feishu.cn/document/ukTMukTMukTM/uEjMzUjLxIzM14SMyMTN /// Authorization:tenant_access_token、user_access_token /// 向电子表格某个工作表的多个指定范围中写入数据。若指定范围已内有数据,将被新写入的数据覆盖。 + /// 使用限制:- 单次写入数据不得超过 5000 行、100列。 + /// - 每个单元格不超过 50,000 字符,由于服务端会增加控制字符,因此推荐每个单元格不超过 40,000 字符。 /// 权限要求: /// drive:drive /// sheets:spreadsheet @@ -1123,6 +1148,9 @@ System.Threading.Tasks.Task PostEphemeralV1DeleteAsync( /// 接口文档:https://open.feishu.cn/document/ukTMukTMukTM/uIjMzUjLyIzM14iMyMTN /// Authorization:tenant_access_token、user_access_token /// 在电子表格工作表的指定范围的起始位置上方增加若干行,并在该范围中填充数据。 + /// 使用限制: + /// - 单次写入数据不可超过 5,000 行、100 列。 + /// - 每个单元格不可超过 50,000 字符,由于服务端会增加控制字符,因此推荐每个单元格不超过 40,000 字符。 /// 权限要求: /// drive:drive /// sheets:spreadsheet @@ -1148,6 +1176,9 @@ System.Threading.Tasks.Task PostEphemeralV1DeleteAsync( /// 接口文档:https://open.feishu.cn/document/ukTMukTMukTM/ugTMzUjL4EzM14COxMTN /// Authorization:tenant_access_token、user_access_token /// 读取电子表格中单个指定范围的数据。 + /// 使用限制: + /// - 该接口返回数据的最大限制为 10 MB。 + /// - 该接口不支持获取跨表引用和数组公式的计算结果。 /// 权限要求: /// drive:drive /// drive:drive:readonly @@ -1359,6 +1390,8 @@ System.Threading.Tasks.Task PostApprovalOpenapiV2SubscriptionSub /// 接口文档:https://open.feishu.cn/document/ukTMukTMukTM/ukDNzUjL5QzM14SO0MTN /// Authorization:tenant_access_token、user_access_token /// 合并电子表格工作表中的单元格。 + /// 使用限制: + /// 单次操作范围不可超过 5,000 行、100 列。 /// 权限要求: /// drive:drive /// sheets:spreadsheet @@ -1389,7 +1422,7 @@ System.Threading.Tasks.Task PostApprovalOpenapiV2SubscriptionSub /// sheets:spreadsheet /// /// - /// + /// /// 路径参数 /// 必填:是 /// 电子表格的 token。可通过以下两种方式获取。了解更多,参考[电子表格概述](https://open.feishu.cn/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/overview)。 @@ -1404,9 +1437,9 @@ System.Threading.Tasks.Task PostApprovalOpenapiV2SubscriptionSub /// 默认值:open_id /// /// 请求体 - [HttpPost("/open-apis/sheets/v2/spreadsheets/{spreadsheetToken}/sheets_batch_update")] + [HttpPost("/open-apis/sheets/v2/spreadsheets/{spreadsheet_token}/sheets_batch_update")] System.Threading.Tasks.Task> PostSheetsV2SpreadsheetsBySpreadsheetTokenSheetsBatchUpdate2Async( - [PathQuery] string spreadsheetToken, + [PathQuery] string spreadsheet_token, [JsonContent] Ccm.Spec.PostSheetsV2SpreadsheetsBySpreadsheetTokenSheetsBatchUpdate2BodyDto dto, [PathQuery] string? user_id_type = "open_id"); @@ -1496,6 +1529,11 @@ System.Threading.Tasks.Task PostApprovalOpenapiV2InstanceCancelA /// 接口文档:https://open.feishu.cn/document/ukTMukTMukTM/uQTNzUjL0UzM14CN1MTN /// Authorization:tenant_access_token、user_access_token /// 该接口用于在云空间指定文件夹中创建电子表格或者多维表格。 + /// 使用限制: + /// - 云空间中根目录或文件夹的单层节点上限为 1500 个。超过此限制时,接口将返回 1062507 错误码。可通过将文件新建到不同文件夹中解决。 + /// - 云空间中所有层级的节点总和的上限为 40 万个。 + /// - 该接口不支持并发调用,且调用频率上限为 5QPS 且 10000次/天。否则会返回 1061045 错误码,可通过稍后重试解决。 + /// - 该接口不支持创建[文档](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-overview)(文档类型为 `docx`),如需创建文档,请调用[创建文档](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/document/create)接口。 /// 权限要求: /// docs:doc /// drive:drive @@ -1536,6 +1574,8 @@ System.Threading.Tasks.Task PostApprovalOpenapiV2InstanceApprove /// 接口文档:https://open.feishu.cn/document/ukTMukTMukTM/uQjMzUjL0IzM14CNyMTN /// Authorization:tenant_access_token、user_access_token /// 该接口用于在电子表格的指定位置插入空白行或列。 + /// 使用限制: + /// 单次调用该接口,最多支持插入 5000 行或列。 /// 权限要求: /// drive:drive /// sheets:spreadsheet @@ -1560,6 +1600,9 @@ System.Threading.Tasks.Task PostSheetsV2SpreadsheetsBySpreadshee /// 接口文档:https://open.feishu.cn/document/ukTMukTMukTM/ukTMzUjL5EzM14SOxMTN /// Authorization:tenant_access_token、user_access_token /// 读取电子表格中多个指定范围的数据。 + /// 使用限制: + /// - 该接口返回数据的最大限制为 10 MB。 + /// - 该接口不支持获取跨表引用和数组公式的计算结果。 /// 权限要求: /// drive:drive /// drive:drive:readonly @@ -1848,6 +1891,9 @@ System.Threading.Tasks.Task PostMeetingRoomBuildingUpdateAsync( /// 接口文档:https://open.feishu.cn/document/ukTMukTMukTM/uUjMzUjL1IzM14SNyMTN /// Authorization:tenant_access_token、user_access_token /// 该接口用于在电子表格工作表中增加空白行或列。 + /// 使用限制: + /// - 单次调用该接口,最多支持增加 5000 行或列。 + /// - 该接口仅支持在工作表的行末尾或列末尾新增行列。要在指定位置新增行列,你需使用[插入行列](https://open.feishu.cn/document/ukTMukTMukTM/uQjMzUjL0IzM14CNyMTN)。 /// 权限要求: /// drive:drive /// sheets:spreadsheet @@ -1926,6 +1972,8 @@ System.Threading.Tasks.Task PostApplicationV3AppUpdateVisibility /// 接口文档:https://open.feishu.cn/document/ukTMukTMukTM/uAjMzUjLwIzM14CMyMTN /// Authorization:tenant_access_token、user_access_token /// 向电子表格某个工作表的单个指定范围中写入数据。若指定范围已内有数据,将被新写入的数据覆盖。 + /// 使用限制:- 单次写入数据不得超过 5000 行、100列。 + /// - 每个单元格不超过 50,000 字符,由于服务端会增加控制字符,因此推荐每个单元格不超过 40,000 字符。 /// 权限要求: /// drive:drive /// sheets:spreadsheet @@ -2020,7 +2068,7 @@ System.Threading.Tasks.Task PostMeetingRoomInstanceReplyAsync( /// sheets:spreadsheet /// /// - /// + /// /// 路径参数 /// 必填:是 /// 电子表格的 token。可通过以下两种方式获取。了解更多,参考[电子表格概述](https://open.feishu.cn/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/overview)。 @@ -2028,9 +2076,9 @@ System.Threading.Tasks.Task PostMeetingRoomInstanceReplyAsync( /// - 调用[获取文件夹中的文件清单](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/list) /// /// 请求体 - [HttpPost("/open-apis/sheets/v2/spreadsheets/{spreadsheetToken}/sheets_batch_update")] + [HttpPost("/open-apis/sheets/v2/spreadsheets/{spreadsheet_token}/sheets_batch_update")] System.Threading.Tasks.Task> PostSheetsV2SpreadsheetsBySpreadsheetTokenSheetsBatchUpdateAsync( - [PathQuery] string spreadsheetToken, + [PathQuery] string spreadsheet_token, [JsonContent] Ccm.Spec.PostSheetsV2SpreadsheetsBySpreadsheetTokenSheetsBatchUpdateBodyDto dto); /// @@ -2559,6 +2607,8 @@ System.Threading.Tasks.Task PostVcV1RoomConfigsSetAsync( /// 接口文档:https://open.feishu.cn/document/ukTMukTMukTM/uIDN1YjLyQTN24iM0UjN/create_attachment /// Authorization:tenant_access_token /// 在招聘系统中上传附件文件,上传的附件为通用附件。 + /// 使用限制: + /// 文件大小不得超过 300 MB。 /// 权限要求: /// hire:attachment /// @@ -2592,9 +2642,10 @@ System.Threading.Tasks.Task PostVcV1RoomConfigsSetAsync( /// 接口ID:6923123667871596572 /// 接口文档:https://open.feishu.cn/document/ukTMukTMukTM/uQTM5YjL0ETO24CNxkjN /// Authorization:tenant_access_token、user_access_token - /// 该接口用于根据保护范围ID查询详细的保护行列信息,最多支持同时查询5个ID。 - /// 1. 仅支持获取保护行或保护列,暂不支持获取保护单元格 - /// 2. 不支持获取包含多个区域的保护范围 + /// 获取电子表格工作表中指定保护范围的信息,包括保护的行列索引、支持编辑的用户 ID、保护范围的备注等。 + /// 使用限制: + /// - 单次调用该接口,最多支持获取 5 个保护范围的信息。 + /// - 不支持获取包含多个区域的保护范围。即如果一个保护范围中添加了多个区域,例如 B22:B26 和 C26:C28,则不支持调用该接口获取。 /// 权限要求: /// drive:drive /// sheets:spreadsheet @@ -2603,15 +2654,22 @@ System.Threading.Tasks.Task PostVcV1RoomConfigsSetAsync( /// /// 路径参数 /// 必填:是 - /// spreadsheet 的 token,获取方式见[在线表格开发指南](https://open.feishu.cn/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/overview) + /// 电子表格的 token。可通过以下两种方式获取。了解更多,参考[电子表格概述](https://open.feishu.cn/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/overview)。 + /// - 电子表格的 URL:https://sample.feishu.cn/sheets/==Iow7sNNEphp3WbtnbCscPqabcef== + /// - 调用[获取文件夹中的文件清单](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/list) + /// **示例值**:"Iow7sNNEphp3WbtnbCscPqabcef" /// /// /// 必填:是 - /// 保护范围ID,可以通过[获取表格元数据](https://open.feishu.cn/document/ukTMukTMukTM/uETMzUjLxEzM14SMxMTN)接口获取,多个ID用逗号分隔,如xxxID1,xxxID2 + /// 保护范围的 ID,可通过[获取表格元数据](https://open.feishu.cn/document/ukTMukTMukTM/uETMzUjLxEzM14SMxMTN)接口获取。多个 ID 之间用逗号分隔。最多可传入 5 个 ID。 + /// **示例值**:"7379738014546812456,7379738014546812456" /// /// /// 必填:否 - /// 返回的用户类型,可选userId,openId,unionId,默认使用userId + /// 返回的用户 ID 的类型。默认为 `userId`,建议选择 `openId`。了解更多,参考[用户身份概述](https://open.feishu.cn/document/home/user-identity-introduction/introduction)。可选值: + /// - `userId`:即 `lark_id`,为全局 ID,标识用户的物理用户身份。 + /// - `openId`:标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。了解更多:[如何获取 Open ID](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid) + /// - `unionId`:标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的,在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID,应用开发商可以把同个用户在多个应用中的身份关联起来。了解更多:[如何获取 Union ID](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-union-id) /// 默认值:null /// [HttpGet("/open-apis/sheets/v2/spreadsheets/{spreadsheetToken}/protected_range_batch_get")] @@ -2625,7 +2683,8 @@ System.Threading.Tasks.Task PostVcV1RoomConfigsSetAsync( /// 接口ID:6923123667871612956 /// 接口文档:https://open.feishu.cn/document/ukTMukTMukTM/uUTM5YjL1ETO24SNxkjN /// Authorization:tenant_access_token、user_access_token - /// 该接口用于根据保护范围ID修改保护范围,单次最多支持同时修改10个ID。 + /// 修改电子表格工作表中指定的保护范围。 + /// 使用限制:单次调用该接口,最多支持修改 10 个保护范围。 /// 权限要求: /// drive:drive /// sheets:spreadsheet @@ -2634,7 +2693,10 @@ System.Threading.Tasks.Task PostVcV1RoomConfigsSetAsync( /// /// 路径参数 /// 必填:是 - /// sheet 的 token,获取方式见[在线表格开发指南](https://open.feishu.cn/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/overview) + /// 电子表格的 token。可通过以下两种方式获取。了解更多,参考[电子表格概述](https://open.feishu.cn/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/overview)。 + /// - 电子表格的 URL:https://sample.feishu.cn/sheets/==Iow7sNNEphp3WbtnbCscPqabcef== + /// - 调用[获取文件夹中的文件清单](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/list) + /// **示例值**:"Iow7sNNEphp3WbtnbCscPqabcef" /// /// 请求体 [HttpPost("/open-apis/sheets/v2/spreadsheets/{spreadsheetToken}/protected_range_batch_update")] @@ -2647,7 +2709,8 @@ System.Threading.Tasks.Task PostVcV1RoomConfigsSetAsync( /// 接口ID:6923123667871629340 /// 接口文档:https://open.feishu.cn/document/ukTMukTMukTM/uYTM5YjL2ETO24iNxkjN /// Authorization:tenant_access_token、user_access_token - /// 该接口用于根据保护范围ID删除保护范围,最多支持同时删除10个ID。 + /// 根据保护范围 ID 删除保护范围。 + /// 注意事项:单次调用该接口,最多支持删除 10 个保护范围。 /// 权限要求: /// drive:drive /// sheets:spreadsheet @@ -2656,7 +2719,10 @@ System.Threading.Tasks.Task PostVcV1RoomConfigsSetAsync( /// /// 路径参数 /// 必填:是 - /// sheet 的 token,获取方式见[在线表格开发指南](https://open.feishu.cn/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/overview) + /// 电子表格的 token。可通过以下两种方式获取。了解更多,参考[电子表格概述](https://open.feishu.cn/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/overview)。 + /// - 电子表格的 URL:https://sample.feishu.cn/sheets/==Iow7sNNEphp3WbtnbCscPqabcef== + /// - 调用[获取文件夹中的文件清单](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/list) + /// **示例值**:"Iow7sNNEphp3WbtnbCscPqabcef" /// /// 请求体 [HttpDelete("/open-apis/sheets/v2/spreadsheets/{spreadsheetToken}/protected_range_batch_del")] @@ -3644,7 +3710,8 @@ System.Threading.Tasks.Task DeleteContactV3DepartmentsByDepartme /// 接口ID:6943917246700257282 /// 接口文档:https://open.feishu.cn/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/datavalidation/delete-datavalidation /// Authorization:tenant_access_token、user_access_token - /// 该接口根据 spreadsheetToken 、range 移除选定数据范围单元格的下拉列表设置,但保留选项文本。单个删除范围不超过5000单元格。单次请求range最大数量100个。 + /// 删除电子表格工作表指定范围中下拉列表的设置,但仍保留选项文本。 + /// 使用限制:单次删除请求可指定多个范围,单个范围指定的单元格不可超过 5,000 个,范围的总数不可超过 100 个。 /// 权限要求: /// drive:drive /// sheets:spreadsheet @@ -3653,7 +3720,9 @@ System.Threading.Tasks.Task DeleteContactV3DepartmentsByDepartme /// /// 路径参数 /// 必填:是 - /// spreadsheet 的 token,获取方式见[在线表格开发指南](https://open.feishu.cn/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/overview) + /// 电子表格的 token。可通过以下两种方式获取。了解更多,参考[电子表格概述](https://open.feishu.cn/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/overview)。 + /// - 电子表格的 URL:https://sample.feishu.cn/sheets/==Iow7sNNEphp3WbtnbCscPqabcef== + /// - 调用[获取文件夹中的文件清单](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/list) /// /// 请求体 [HttpDelete("/open-apis/sheets/v2/spreadsheets/{spreadsheetToken}/dataValidation")] @@ -3666,7 +3735,9 @@ System.Threading.Tasks.Task DeleteContactV3DepartmentsByDepartme /// 接口ID:6943917246700290050 /// 接口文档:https://open.feishu.cn/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/datavalidation/set-dropdown /// Authorization:tenant_access_token、user_access_token - /// 该接口根据 spreadsheetToken 、range 和下拉列表属性给单元格设置下拉列表规则;单次设置范围不超过5000行,100列。当一个数据区域中已有数据,支持将有效数据直接转为选项。 + /// 在电子表格工作表中为指定区域添加下拉列表选项,并设置下拉列表的属性,包括是否支持多选、设置下拉选项样式等。若一个数据区域中已有数据,支持将有效数据直接转为下拉列表中的选项。 + /// 使用限制: + /// 单次调用该接口,最多支持为 5,000 行、100 列设置下拉列表。 /// 权限要求: /// drive:drive /// sheets:spreadsheet @@ -3675,11 +3746,13 @@ System.Threading.Tasks.Task DeleteContactV3DepartmentsByDepartme /// /// 路径参数 /// 必填:是 - /// spreadsheet 的 token,获取方式见[在线表格开发指南](https://open.feishu.cn/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/overview) + /// 电子表格的 token。可通过以下两种方式获取。了解更多,参考[电子表格概述](https://open.feishu.cn/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/overview)。 + /// - 电子表格的 URL:https://sample.feishu.cn/sheets/==Iow7sNNEphp3WbtnbCscPqabcef== + /// - 调用[获取文件夹中的文件清单](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/list) /// /// 请求体 [HttpPost("/open-apis/sheets/v2/spreadsheets/{spreadsheetToken}/dataValidation")] - System.Threading.Tasks.Task PostSheetsV2SpreadsheetsBySpreadsheetTokenDataValidationAsync( + System.Threading.Tasks.Task> PostSheetsV2SpreadsheetsBySpreadsheetTokenDataValidationAsync( [PathQuery] string spreadsheetToken, [JsonContent] Ccm.Spec.PostSheetsV2SpreadsheetsBySpreadsheetTokenDataValidationBodyDto dto); @@ -3688,7 +3761,9 @@ System.Threading.Tasks.Task PostSheetsV2SpreadsheetsBySpreadshee /// 接口ID:6943917246700306434 /// 接口文档:https://open.feishu.cn/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/datavalidation/query-datavalidation /// Authorization:tenant_access_token、user_access_token - /// 该接口根据 spreadsheetToken 、range 查询range内的下拉列表设置信息;单次查询范围不超过5000行,100列。 + /// 查询电子表格工作表中指定范围的下拉列表的设置信息。 + /// 使用限制: + /// 单次查询范围不得超过 5000 行、100列。 /// 权限要求: /// drive:drive /// sheets:spreadsheet @@ -3697,15 +3772,19 @@ System.Threading.Tasks.Task PostSheetsV2SpreadsheetsBySpreadshee /// /// 路径参数 /// 必填:是 - /// spreadsheet 的 token,获取方式见 [在线表格开发指南](https://open.feishu.cn/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/overview) + /// 电子表格的 token。可通过以下两种方式获取。了解更多,参考[电子表格概述](https://open.feishu.cn/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/overview)。 + /// - 电子表格的 URL:https://sample.feishu.cn/sheets/==Iow7sNNEphp3WbtnbCscPqabcef== + /// - 调用[获取文件夹中的文件清单](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/list) /// /// /// 必填:是 - /// 查询范围,包含 sheetId 与单元格范围两部分,目前支持四种索引方式,详见[在线表格开发指南](https://open.feishu.cn/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/overview) + /// 查询范围。格式为 `<sheetId>!<开始位置>:<结束位置>`。其中: + /// - `sheetId` 为工作表 ID,通过[获取工作表](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet/query) 获取 + /// - `<开始位置>:<结束位置>` 为工作表中单元格的范围,数字表示行索引,字母表示列索引。如 `A2:B2` 表示该工作表第 2 行的 A 列到 B 列。`range`支持四种写法,详情参考[电子表格概述](https://open.feishu.cn/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/overview) /// /// /// 必填:是 - /// 固定为"list",表示下拉列表 + /// 数据验证类型。取固定值 "list",表示下拉列表。 /// [HttpGet("/open-apis/sheets/v2/spreadsheets/{spreadsheetToken}/dataValidation")] System.Threading.Tasks.Task> GetSheetsV2SpreadsheetsBySpreadsheetTokenDataValidationAsync( @@ -3718,7 +3797,7 @@ System.Threading.Tasks.Task PostSheetsV2SpreadsheetsBySpreadshee /// 接口ID:6943917246700322818 /// 接口文档:https://open.feishu.cn/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/datavalidation/update-datavalidation /// Authorization:tenant_access_token、user_access_token - /// 该接口根据 spreadsheetToken 、sheetId、dataValidationId 更新下拉列表的属性。 + /// 更新电子表格工作表中单个下拉列表的设置,支持更新下拉列表的选项和属性,包括是否支持多选、下拉选项的样式等。 /// 权限要求: /// drive:drive /// sheets:spreadsheet @@ -3727,17 +3806,19 @@ System.Threading.Tasks.Task PostSheetsV2SpreadsheetsBySpreadshee /// /// 路径参数 /// 必填:是 - /// spreadsheet 的 token,获取方式见[在线表格开发指南](https://open.feishu.cn/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/overview) + /// 电子表格的 token。可通过以下两种方式获取。了解更多,参考[电子表格概述](https://open.feishu.cn/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/overview)。 + /// - 电子表格的 URL:https://sample.feishu.cn/sheets/==Iow7sNNEphp3WbtnbCscPqabcef== + /// - 调用[获取文件夹中的文件清单](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/list) /// /// /// 路径参数 /// 必填:是 - /// 子sheet唯一识别参数 + /// 电子表格工作表的 ID。调用[获取工作表](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet/query)获取 ID。 /// /// /// 路径参数 /// 必填:是 - /// sheet中下拉列表的唯一标示id + /// 电子表格工作表中下拉列表的 ID。调用[查询下拉列表](https://open.feishu.cn/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/datavalidation/query-datavalidation)获取 ID。 /// /// 请求体 [HttpPut("/open-apis/sheets/v2/spreadsheets/{spreadsheetToken}/dataValidation/{sheetId}/{dataValidationId}")] @@ -4919,8 +5000,8 @@ System.Threading.Tasks.Task GetEhrV1AttachmentsByTokenAsync /// /// 请求体 [HttpPost("/open-apis/optical_char_recognition/v1/image/basic_recognize")] - System.Threading.Tasks.Task> PostOpticalCharRecognitionV1ImageBasicRecognizeAsync( - [JsonContent] Ai.Spec.PostOpticalCharRecognitionV1ImageBasicRecognizeBodyDto dto); + System.Threading.Tasks.Task> PostOpticalCharRecognitionV1ImageBasicRecognizeAsync( + [JsonContent] Ai.PostOpticalCharRecognitionV1ImageBasicRecognizeBodyDto dto); /// /// 【AI 能力】识别流式语音 @@ -5702,6 +5783,7 @@ System.Threading.Tasks.Task PutImV1ChatsByChatIdModerationAsync( /// 权限要求: /// calendar:calendar /// calendar:calendar:readonly + /// calendar:calendar.event:read /// /// 字段权限要求: /// contact:user.employee_id:readonly @@ -5776,6 +5858,7 @@ System.Threading.Tasks.Task PutImV1ChatsByChatIdModerationAsync( /// 调用该接口以当前身份(应用或用户)订阅指定的日历。 /// 权限要求: /// calendar:calendar + /// calendar:calendar:subscribe /// /// /// @@ -5799,6 +5882,7 @@ System.Threading.Tasks.Task PutImV1ChatsByChatIdModerationAsync( /// Authorization:tenant_access_token /// 调用该接口删除一个指定的请假日程。请假日程删除后,用户个人签名页的请假信息也会消失。 /// 权限要求: + /// calendar:time_off:delete /// calendar:timeoff /// /// @@ -5821,6 +5905,7 @@ System.Threading.Tasks.Task DeleteCalendarV4TimeoffEventsByTimeo /// 权限要求: /// calendar:calendar /// calendar:calendar:readonly + /// calendar:calendar.event:read /// /// 字段权限要求: /// contact:user.employee_id:readonly @@ -5911,6 +5996,7 @@ System.Threading.Tasks.Task DeleteCalendarV4TimeoffEventsByTimeo /// 调用该接口以当前身份(应用或用户)为指定日历添加访问控制,即日历成员权限。 /// 权限要求: /// calendar:calendar + /// calendar:calendar.acl:create /// /// 字段权限要求: /// contact:user.employee_id:readonly @@ -5952,6 +6038,7 @@ System.Threading.Tasks.Task DeleteCalendarV4TimeoffEventsByTimeo /// 调用该接口以当前身份(应用或用户)删除指定日程的一个或多个参与人。 /// 权限要求: /// calendar:calendar + /// calendar:calendar.event:update /// /// 字段权限要求: /// contact:user.employee_id:readonly @@ -6000,6 +6087,7 @@ System.Threading.Tasks.Task PostCalendarV4CalendarsByCalendarIdE /// 权限要求: /// calendar:calendar /// calendar:calendar:readonly + /// calendar:calendar.event:read /// /// 字段权限要求: /// contact:user.employee_id:readonly @@ -6067,6 +6155,7 @@ System.Threading.Tasks.Task PostCalendarV4CalendarsByCalendarIdE /// 调用该接口通过关键字搜索日历,搜索结果为标题或描述包含关键字的公共日历或用户主日历。 /// 权限要求: /// calendar:calendar + /// calendar:calendar:read /// calendar:calendar:readonly /// /// @@ -6097,6 +6186,7 @@ System.Threading.Tasks.Task PostCalendarV4CalendarsByCalendarIdE /// 调用该接口分页查询当前身份(应用或用户)的日历列表。 /// 权限要求: /// calendar:calendar + /// calendar:calendar:read /// calendar:calendar:readonly /// /// @@ -6134,6 +6224,7 @@ System.Threading.Tasks.Task PostCalendarV4CalendarsByCalendarIdE /// 权限要求: /// calendar:calendar /// calendar:calendar:readonly + /// calendar:calendar.event:read /// /// 字段权限要求: /// contact:user.employee_id:readonly @@ -6205,6 +6296,7 @@ System.Threading.Tasks.Task PostCalendarV4CalendarsByCalendarIdE /// 权限要求: /// calendar:calendar /// calendar:calendar:readonly + /// calendar:calendar.free_busy:read /// /// 字段权限要求: /// contact:user.employee_id:readonly @@ -6235,6 +6327,7 @@ System.Threading.Tasks.Task PostCalendarV4CalendarsByCalendarIdE /// 调用该接口以当前身份(应用或用户)删除指定日历内的某一访问控制,即成员权限。 /// 权限要求: /// calendar:calendar + /// calendar:calendar.acl:delete /// /// /// @@ -6267,6 +6360,7 @@ System.Threading.Tasks.Task DeleteCalendarV4CalendarsByCalendarI /// 调用该接口以当前身份(应用或用户)删除指定日历上的一个日程。 /// 权限要求: /// calendar:calendar + /// calendar:calendar.event:delete /// /// /// @@ -6309,6 +6403,7 @@ System.Threading.Tasks.Task DeleteCalendarV4CalendarsByCalendarI /// 调用该接口以当前身份(应用或用户)查询指定日历的信息。 /// 权限要求: /// calendar:calendar + /// calendar:calendar:read /// calendar:calendar:readonly /// /// @@ -6334,6 +6429,7 @@ System.Threading.Tasks.Task DeleteCalendarV4CalendarsByCalendarI /// 调用该接口以当前身份(应用或用户)删除某一指定的共享日历。 /// 权限要求: /// calendar:calendar + /// calendar:calendar:delete /// /// /// @@ -6358,6 +6454,7 @@ System.Threading.Tasks.Task DeleteCalendarV4CalendarsByCalendarI /// 调用该接口以当前身份(应用或用户)更新指定日历上的一个日程,包括日程标题、描述、开始与结束时间、视频会议以及日程地点等信息。 /// 权限要求: /// calendar:calendar + /// calendar:calendar.event:update /// /// 字段权限要求: /// contact:user.employee_id:readonly @@ -6405,6 +6502,7 @@ System.Threading.Tasks.Task DeleteCalendarV4CalendarsByCalendarI /// 调用该接口为当前身份(应用或用户)创建一个共享日历。 /// 权限要求: /// calendar:calendar + /// calendar:calendar:create /// /// /// 请求体 @@ -6420,6 +6518,7 @@ System.Threading.Tasks.Task DeleteCalendarV4CalendarsByCalendarI /// 调用该接口以当前身份(应用或用户)取消指定日历的订阅状态。 /// 权限要求: /// calendar:calendar + /// calendar:calendar:subscribe /// /// /// @@ -6445,6 +6544,7 @@ System.Threading.Tasks.Task PostCalendarV4CalendarsByCalendarIdU /// 权限要求: /// calendar:calendar /// calendar:calendar:readonly + /// calendar:calendar.event:read /// /// 字段权限要求: /// contact:user.employee_id:readonly @@ -6496,6 +6596,7 @@ System.Threading.Tasks.Task PostCalendarV4CalendarsByCalendarIdU /// 调用该接口以当前身份(应用或用户)为指定日程添加一个或多个参与人,参与人类型包括用户、群组、会议室以及邮箱。 /// 权限要求: /// calendar:calendar + /// calendar:calendar.event:update /// /// 字段权限要求: /// contact:user.employee_id:readonly @@ -6542,6 +6643,7 @@ System.Threading.Tasks.Task PostCalendarV4CalendarsByCalendarIdU /// Authorization:tenant_access_token /// 调用该接口为指定用户创建一个请假日程。请假日程分为普通日程和全天日程。创建请假日程后,在请假时间内,用户个人签名页会展示请假信息。 /// 权限要求: + /// calendar:time_off:create /// calendar:timeoff /// /// 字段权限要求: @@ -6573,6 +6675,7 @@ System.Threading.Tasks.Task PostCalendarV4CalendarsByCalendarIdU /// 调用该接口以当前身份(应用或用户)修改指定日历的标题、描述、公开范围等信息。 /// 权限要求: /// calendar:calendar + /// calendar:calendar:update /// /// /// @@ -6600,6 +6703,7 @@ System.Threading.Tasks.Task PostCalendarV4CalendarsByCalendarIdU /// 权限要求: /// calendar:calendar /// calendar:calendar:readonly + /// calendar:calendar.acl:read /// /// 字段权限要求: /// contact:user.employee_id:readonly @@ -9838,13 +9942,14 @@ System.Threading.Tasks.Task DeleteVcV1ReservesByReserveIdAsync( /// /// 必填:否 /// 分页大小 + /// **默认值**:1000 /// 示例值:10 /// 默认值:10 /// /// /// 必填:否 /// 分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果 - /// 示例值:1 + /// 示例值:"6794694704606185741" /// 默认值:null /// [HttpGet("/open-apis/hire/v1/resume_sources")] @@ -13626,6 +13731,7 @@ System.Threading.Tasks.Task PatchApplicationV6ApplicationsByAppI /// 调用该接口以当前身份(应用或用户)在指定日历上创建一个日程。 /// 权限要求: /// calendar:calendar + /// calendar:calendar.event:create /// /// 字段权限要求: /// contact:user.employee_id:readonly @@ -13775,6 +13881,28 @@ System.Threading.Tasks.Task PatchApplicationV6ApplicationsByAppI [PathQuery] string message_id, [JsonContent] Im.PostImV1MessagesByMessageIdReactionsBodyDto dto); + /// + /// 【招聘】新建招聘官网用户 + /// 接口ID:6990661791098634243 + /// 接口文档:https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/website-site_user/create + /// Authorization:tenant_access_token + /// 注册指定招聘官网的用户,注册完成后,可通过[创建招聘官网投递任务](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/website-delivery/create_by_attachment)创建官网投递任务,或通过[新建招聘官网投递](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/website-delivery/create_by_resume)创建官网投递 + /// 权限要求: + /// hire:site + /// + /// + /// + /// 路径参数 + /// 必填:是 + /// 官网 ID,可通过[获取招聘官网列表](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/website/list)获取 + /// 示例值:1618209327096 + /// + /// 请求体 + [HttpPost("/open-apis/hire/v1/websites/{website_id}/site_users")] + System.Threading.Tasks.Task> PostHireV1WebsitesByWebsiteIdSiteUsersAsync( + [PathQuery] string website_id, + [JsonContent] Hire.PostHireV1WebsitesByWebsiteIdSiteUsersBodyDto dto); + /// /// 【招聘】获取招聘官网下的职位列表 /// 接口ID:6990661791098667011 @@ -13911,6 +14039,35 @@ System.Threading.Tasks.Task PatchApplicationV6ApplicationsByAppI [PathQuery] string? page_token = null, [PathQuery] int? page_size = 10); + /// + /// 【招聘】获取招聘官网列表 + /// 接口ID:6990661791098699779 + /// 接口文档:https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/website/list + /// Authorization:tenant_access_token + /// 获取招聘官网列表,返回信息包括官网名称、官网ID、职位渠道ID等。 + /// 权限要求: + /// hire:site + /// hire:site:readonly + /// + /// + /// + /// 必填:否 + /// 分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果 + /// 示例值:eyJvZmZzZXQiOjEwLCJ0aW1lc3RhbXAiOjE2Mjc1NTUyMjM2NzIsImlkIjpudWxsfQ== + /// 默认值:null + /// + /// + /// 必填:否 + /// 每页获取记录数量 + /// **默认值** : 10 + /// 示例值:10 + /// 默认值:10 + /// + [HttpGet("/open-apis/hire/v1/websites")] + System.Threading.Tasks.Task> GetHireV1WebsitesAsync( + [PathQuery] string? page_token = null, + [PathQuery] int? page_size = 10); + /// /// 【招聘】创建外部面试 /// 接口ID:6992822583076339715 @@ -15335,6 +15492,28 @@ System.Threading.Tasks.Task PostContactV3GroupByGroupIdMemberRem [PathQuery] string? job_level_id_type = "people_admin_job_level_id", [PathQuery] string? job_family_id_type = "people_admin_job_category_id"); + /// + /// 【招聘】职位发布至官网 + /// 接口ID:7012986483075547137 + /// 接口文档:https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/advertisement/publish + /// Authorization:tenant_access_token + /// 支持把职位发布至招聘官网、内推平台。 + /// 权限要求: + /// hire:advertisement + /// + /// + /// + /// 路径参数 + /// 必填:是 + /// 职位广告 ID + /// 示例值:6960663240925956660 + /// + /// 请求体 + [HttpPost("/open-apis/hire/v1/advertisements/{advertisement_id}/publish")] + System.Threading.Tasks.Task PostHireV1AdvertisementsByAdvertisementIdPublishAsync( + [PathQuery] string advertisement_id, + [JsonContent] Hire.PostHireV1AdvertisementsByAdvertisementIdPublishBodyDto dto); + /// /// 【招聘】更新职位设置 /// 接口ID:7012986483075563521 @@ -16428,7 +16607,7 @@ System.Threading.Tasks.Task DeleteCorehrV1ContractsByContractIdA /// 接口ID:7017707615190958083 /// 接口文档:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/pre_hire/list /// Authorization:tenant_access_token - /// 可通过本接口批量查询待入职人员信息,本接口和[搜索接口](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/pre_hire/search)相比较无延迟问题。 + /// 可通过本接口批量查询待入职人员信息,本接口不再推荐使用(个人信息相关数据不完整),请使用[查询待入职](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/pre_hire/query)接口获取更完整信息。 /// 权限要求: /// corehr:corehr /// corehr:corehr:readonly @@ -16450,10 +16629,11 @@ System.Threading.Tasks.Task DeleteCorehrV1ContractsByContractIdA /// /// /// 必填:否 - /// 待入职ID列表,可通过[搜索接口](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/pre_hire/search)接口获取 + /// 待入职ID列表,可通过[搜索待入职](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/pre_hire/search)接口获取 /// 示例值:7110120266637772332 /// 默认值:null /// + [Obsolete("迁移至新版本:https://open.feishu.cn/documenthttps://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/pre_hire/query")] [HttpGet("/open-apis/corehr/v1/pre_hires")] System.Threading.Tasks.Task> GetCorehrV1PreHiresAsync( [PathQuery] string? page_token = null, @@ -16704,7 +16884,7 @@ System.Threading.Tasks.Task DeleteCorehrV1ContractsByContractIdA /// 接口ID:7017707615191089155 /// 接口文档:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/pre_hire/get /// Authorization:tenant_access_token - /// 根据 ID 查询单个待入职人员。 + /// 根据 ID 查询单个待入职人员,本接口不再推荐使用(个人信息相关数据不完整),请使用[查询待入职](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/pre_hire/query)接口获取更完整信息。 /// 权限要求: /// corehr:corehr /// corehr:corehr:readonly @@ -16715,9 +16895,10 @@ System.Threading.Tasks.Task DeleteCorehrV1ContractsByContractIdA /// /// 路径参数 /// 必填:是 - /// 待入职ID,可从[待入职列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/pre_hire/search)接口获取 + /// 待入职ID,可从[搜索待入职人员信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/pre_hire/search)接口获取 /// 示例值:121215 /// + [Obsolete("迁移至新版本:https://open.feishu.cn/documenthttps://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/pre_hire/query")] [HttpGet("/open-apis/corehr/v1/pre_hires/{pre_hire_id}")] System.Threading.Tasks.Task> GetCorehrV1PreHiresByPreHireIdAsync( [PathQuery] string pre_hire_id); @@ -18540,11 +18721,11 @@ System.Threading.Tasks.Task PostImV1ChatsByChatIdTopNoticeDelete /// /// /// 必填:是 - /// 用户 ID 的类型 + /// 请求体和响应体中的 user_id 和 creator_id 的员工id类型。如果没有后台管理权限,可使用[通过手机号或邮箱获取用户 ID](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/batch_get_id) /// 示例值:employee_id /// - /// employee_id:员工 employeeId - /// employee_no:员工工号 + /// employee_id:员工 employee ID,即[飞书管理后台](https://example.feishu.cn/admin/contacts/departmentanduser) > 组织架构 > 成员与部门 > 成员详情中的用户 ID + /// employee_no:员工工号,即[飞书管理后台](https://example.feishu.cn/admin/contacts/departmentanduser) > 组织架构 > 成员与部门 > 成员详情中的工号 /// /// /// @@ -18573,7 +18754,7 @@ System.Threading.Tasks.Task PostImV1ChatsByChatIdTopNoticeDelete /// /// /// 必填:是 - /// 请求体和响应体中的 user_id 的员工ID类型 + /// 请求体和响应体中的 user_id 的员工ID类型。如果没有后台管理权限,可使用[通过手机号或邮箱获取用户 ID](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/batch_get_id) /// 示例值:employee_id /// /// employee_id:员工 employee ID,即[飞书管理后台](https://example.feishu.cn/admin/contacts/departmentanduser) > 组织架构 > 成员与部门 > 成员详情中的用户 ID @@ -18616,14 +18797,30 @@ System.Threading.Tasks.Task PostImV1ChatsByChatIdTopNoticeDelete /// 接口ID:7044467124773421057 /// 接口文档:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_task/query /// Authorization:tenant_access_token - /// 获取企业内员工的实际打卡结果,包括上班打卡结果和下班打卡结果。 + /// 获取企业内员工的实际打卡结果,包括: + /// * 打卡任务列表 + /// * 打卡记录id + /// * 用户信息 + /// * 考勤组id + /// * 班次id + /// * 考勤记录 + /// * 上班记录 + /// * 下班记录 + /// * 上班打卡结果 + /// * 下班打卡结果 + /// * 上班打卡结果补充 + /// * 下班打卡结果补充 + /// * 上班打卡时间 + /// * 下班打卡时间 + /// * 无效用户id列表 + /// * 没有权限用户ID列表 /// 权限要求: /// attendance:task:readonly /// /// /// /// 必填:是 - /// 员工工号类型 + /// 员工ID类型。如果没有后台管理权限,可使用[通过手机号或邮箱获取用户 ID](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/batch_get_id) /// 示例值:employee_id /// /// employee_id:员工 employee ID,即[飞书管理后台](https://example.feishu.cn/admin/contacts/departmentanduser) > 组织架构 > 成员与部门 > 成员详情中的用户 ID @@ -18632,13 +18829,13 @@ System.Threading.Tasks.Task PostImV1ChatsByChatIdTopNoticeDelete /// /// /// 必填:否 - /// 是否忽略无效和没有权限的用户。如果 true,则返回有效用户的信息,并告知无效和没有权限的用户信息;如果 false,且 user_ids 中存在无效或没有权限的用户,则返回错误 + /// 是否忽略无效和没有权限的用户,对应employee_type。如果 true,则返回有效用户的信息,并告知无效和没有权限的用户信息;如果 false,且 user_ids 中存在无效或没有权限的用户,则返回错误 /// 示例值:true /// 默认值:null /// /// /// 必填:否 - /// 由于新入职员工可以复用已离职员工的 employee_no/employee_id,如果 true,则返回 employee_no/employee_id 对应的所有在职 + 离职员工的数据;如果 false,则只返回 employee_no/employee_id 对应的在职或最近一个离职员工的数据 + /// 由于新入职员工可以复用已离职员工的 employee_no/employee_id,对应employee_type。如果 true,则返回 employee_no/employee_id 对应的所有在职 + 离职员工的数据;如果 false,则只返回 employee_no/employee_id 对应的在职或最近一个离职员工的数据 /// 示例值:true /// 默认值:null /// @@ -18662,7 +18859,7 @@ System.Threading.Tasks.Task PostImV1ChatsByChatIdTopNoticeDelete /// /// /// 必填:是 - /// 请求体和响应体中的 user_id 和 creator_id 的员工id类型 + /// 请求体和响应体中的 user_id 和 creator_id 的员工id类型。如果没有后台管理权限,可使用[通过手机号或邮箱获取用户 ID](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/batch_get_id) /// 示例值:employee_id /// /// employee_id:员工 employee ID,即[飞书管理后台](https://example.feishu.cn/admin/contacts/departmentanduser) > 组织架构 > 成员与部门 > 成员详情中的用户 ID @@ -18726,7 +18923,16 @@ System.Threading.Tasks.Task PostImV1ChatsByChatIdTopNoticeDelete /// 接口ID:7044467124773535745 /// 接口文档:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_flow/get /// Authorization:tenant_access_token - /// 通过打卡记录 ID 获取用户的打卡流水记录。 + /// 通过打卡记录 ID 获取用户的打卡流水记录。返回信息主要包含: + /// * 用户id和创建者id + /// * 记录信息 + /// * 打卡位置信息、时间信息 + /// * 打卡方式信息 + /// * GPS 打卡:location_name(定位地址信息) + /// * Wi-Fi 打卡:ssid(wifi名称)、bssid(mac地址) + /// * 考勤机打卡:device_id(考勤机设备id) + /// * 打卡结果 + /// 对应页面功能打卡管理-[打卡记录](https://example.feishu.cn/people/workforce-management/manage/statistics/flow) /// 权限要求: /// attendance:task /// attendance:task:readonly @@ -18740,12 +18946,12 @@ System.Threading.Tasks.Task PostImV1ChatsByChatIdTopNoticeDelete /// /// /// 必填:是 - /// 响应体中的 user_id 和 creator_id 的员工工号类型 + /// 响应体中的 user_id 和 creator_id 的员工ID类型。如果没有后台管理权限,可使用[通过手机号或邮箱获取用户 ID](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/batch_get_id) /// 示例值:employee_id /// - /// open_id:开放 openID - /// employee_id:员工 employee ID,即飞书管理后台 > 组织架构 > 成员与部门 > 成员详情中的用户 ID - /// employee_no:员工工号,即飞书管理后台 > 组织架构 > 成员与部门 > 成员详情中的工号 + /// open_id:开放 openID,[如何获取不同的用户 ID]((https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/home/user-identity-introduction/open-id)) + /// employee_id:员工 employee ID,即[飞书管理后台](https://example.feishu.cn/admin/contacts/departmentanduser) > 组织架构 > 成员与部门 > 成员详情中的用户 ID + /// employee_no:员工工号,即[飞书管理后台](https://example.feishu.cn/admin/contacts/departmentanduser) > 组织架构 > 成员与部门 > 成员详情中的工号 /// /// [HttpGet("/open-apis/attendance/v1/user_flows/{user_flow_id}")] @@ -18765,7 +18971,7 @@ System.Threading.Tasks.Task PostImV1ChatsByChatIdTopNoticeDelete /// /// /// 必填:是 - /// 请求体中的 user_ids 和响应体中的 user_id 的员工ID类型 + /// 请求体中的 user_ids 和响应体中的 user_id 的员工ID类型。如果没有后台管理权限,可使用[通过手机号或邮箱获取用户 ID](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/batch_get_id) /// 示例值:employee_id /// /// employee_id:员工 employee ID,即[飞书管理后台](https://example.feishu.cn/admin/contacts/departmentanduser) > 组织架构 > 成员与部门 > 成员详情中的用户 ID @@ -18791,7 +18997,7 @@ System.Threading.Tasks.Task PostImV1ChatsByChatIdTopNoticeDelete /// /// /// 必填:是 - /// 请求体中的 user_ids 和响应体中的 user_id 的员工ID类型 + /// 请求体中的 user_ids 和响应体中的 user_id 的员工ID类型。如果没有后台管理权限,可使用[通过手机号或邮箱获取用户 ID](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/batch_get_id) /// 示例值:employee_id /// /// employee_id:员工 employee ID,即[飞书管理后台](https://example.feishu.cn/admin/contacts/departmentanduser) > 组织架构 > 成员与部门 > 成员详情中的用户 ID @@ -18809,18 +19015,19 @@ System.Threading.Tasks.Task PostImV1ChatsByChatIdTopNoticeDelete /// 接口ID:7044467124773584897 /// 接口文档:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_setting/query /// Authorization:tenant_access_token - /// 批量查询授权内员工的用户设置信息,包括人脸照片文件 ID、人脸照片更新时间。 + /// 批量查询授权内员工的用户设置信息,包括人脸照片文件 ID、人脸照片更新时间。对应页面假勤设置-[人脸识别](https://example.feishu.cn/people/workforce-management/setting/group/security)。根据返回的face_key可以下载人脸信息[下载用户人脸识别照片 + /// ](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/file/download) /// 权限要求: /// attendance:rule:readonly /// /// /// /// 必填:是 - /// 请求体中的 user_ids 和响应体中的 user_id 的员工工号类型 + /// 请求体中的 user_ids 和响应体中的 user_id 的员工ID类型。如果没有后台管理权限,可使用[通过手机号或邮箱获取用户 ID](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/batch_get_id) /// 示例值:employee_id /// - /// employee_id:员工 employee ID,即飞书管理后台 > 组织架构 > 成员与部门 > 成员详情中的用户 ID - /// employee_no:员工工号,即飞书管理后台 > 组织架构 > 成员与部门 > 成员详情中的工号 + /// employee_id:员工 employee ID,即[飞书管理后台](https://example.feishu.cn/admin/contacts/departmentanduser) > 组织架构 > 成员与部门 > 成员详情中的用户 ID + /// employee_no:员工工号,即[飞书管理后台](https://example.feishu.cn/admin/contacts/departmentanduser) > 组织架构 > 成员与部门 > 成员详情中的工号 /// /// /// 请求体 @@ -18849,18 +19056,27 @@ System.Threading.Tasks.Task PostImV1ChatsByChatIdTopNoticeDelete /// 接口ID:7044467124773617665 /// 接口文档:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_flow/query /// Authorization:tenant_access_token - /// 批量查询授权内员工的实际打卡流水记录。例如,企业给一个员工设定的班次是上午 9 点和下午 6 点各打一次上下班卡,但是该员工在这期间打了多次卡,该接口会把所有的打卡记录都返回。 + /// 通过打卡记录 ID 获取用户的打卡流水记录。返回信息主要包含: + /// * 用户id和创建者id + /// * 记录信息 + /// * 打卡位置信息、时间信息 + /// * 打卡方式信息 + /// * GPS 打卡:location_name(定位地址信息) + /// * Wi-Fi 打卡:ssid(wifi名称)、bssid(mac地址) + /// * 考勤机打卡:device_id(考勤机设备id) + /// * 打卡结果 + /// 对应页面功能打卡管理-[打卡记录](https://example.feishu.cn/people/workforce-management/manage/statistics/flow) /// 权限要求: /// attendance:task:readonly /// /// /// /// 必填:是 - /// 请求体中的 user_ids 和响应体中的 user_id 的员工工号类型 + /// 请求体中的 user_ids 和响应体中的 user_id 的员工ID类型。如果没有后台管理权限,可使用[通过手机号或邮箱获取用户 ID](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/batch_get_id) /// 示例值:employee_id /// - /// employee_id:员工 employee ID,即飞书管理后台 > 组织架构 > 成员与部门 > 成员详情中的用户 ID - /// employee_no:员工工号,即飞书管理后台 > 组织架构 > 成员与部门 > 成员详情中的工号 + /// employee_id:员工 employee ID,即[飞书管理后台](https://example.feishu.cn/admin/contacts/departmentanduser) > 组织架构 > 成员与部门 > 成员详情中的用户 ID + /// employee_no:员工工号,即[飞书管理后台](https://example.feishu.cn/admin/contacts/departmentanduser) > 组织架构 > 成员与部门 > 成员详情中的工号 /// /// /// @@ -18932,18 +19148,18 @@ System.Threading.Tasks.Task PostImV1ChatsByChatIdTopNoticeDelete /// 接口ID:7044467124773666817 /// 接口文档:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_task_remedy/query /// Authorization:tenant_access_token - /// 获取授权内员工的补卡记录。 + /// 补卡:用户通过审批的方式,在某一次上/下班的打卡时间范围内,补充一条打卡记录,用以修正用户的考勤结果。本接口专用于获取员工的补卡记录(无页面功能对应) /// 权限要求: /// attendance:task:readonly /// /// /// /// 必填:是 - /// 请求体中的 user_ids 和响应体中的 user_id 的员工工号类型 + /// 请求体中的 user_ids 和响应体中的 user_id 的员工ID类型。如果没有后台管理权限,可使用[通过手机号或邮箱获取用户 ID](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/batch_get_id) /// 示例值:employee_id /// - /// employee_id:员工 employee ID,即飞书管理后台 > 组织架构 > 成员与部门 > 成员详情中的用户 ID - /// employee_no:员工工号,即飞书管理后台 > 组织架构 > 成员与部门 > 成员详情中的工号 + /// employee_id:员工 employee ID,即[飞书管理后台](https://example.feishu.cn/admin/contacts/departmentanduser) > 组织架构 > 成员与部门 > 成员详情中的用户 ID + /// employee_no:员工工号,即[飞书管理后台](https://example.feishu.cn/admin/contacts/departmentanduser) > 组织架构 > 成员与部门 > 成员详情中的工号 /// /// /// 请求体 @@ -19330,6 +19546,7 @@ System.Threading.Tasks.Task DeleteOkrV1ProgressRecordsByProgress /// Authorization:tenant_access_token、user_access_token /// 调用该接口获取当前身份(应用或用户)的主日历信息。 /// 权限要求: + /// calendar:calendar:read /// calendar:calendar:readonly /// /// 字段权限要求: @@ -21581,13 +21798,16 @@ System.Threading.Tasks.Task PostAdminV1PasswordResetAsync( /// 接口ID:7088940762189545473 /// 接口文档:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_change/create /// Authorization:tenant_access_token - /// 创建员工异动信息。 + /// 该接口用于发起员工异动(变更员工雇佣信息),若发起成功,会生成一条员工的异动数据,同时产生相应的事件:[异动状态变更事件](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_change/events/updated) /// 权限要求: /// corehr:corehr /// corehr:job_change:write /// /// 字段权限要求: /// contact:user.employee_id:readonly + /// corehr:job_change.employment_custom_field:read + /// corehr:job_data.compensation_type:read + /// corehr:job_data.service_company:read /// /// /// @@ -21881,7 +22101,7 @@ System.Threading.Tasks.Task PostDriveV1FilesByFileTokenSubscribe /// 接口ID:7097044451155214340 /// 接口文档:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/offboarding/submit /// Authorization:tenant_access_token - /// 该接口用于发起员工离职,相当于人事系统员工的直接离职功能。若发起成功,会生成一条员工的离职数据,同时产生相应的事件。参考[离职申请状态变更(新)](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/offboarding/events/status_updated)和[离职流转状态变更](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/offboarding/events/checklist_updated) + /// 该接口用于发起员工离职。若发起成功,会生成一条员工的离职数据,同时产生相应的事件。参考[离职申请状态变更](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/offboarding/events/status_updated) /// 权限要求: /// corehr:corehr /// corehr:offboarding:write @@ -21913,7 +22133,7 @@ System.Threading.Tasks.Task PostDriveV1FilesByFileTokenSubscribe /// 接口ID:7097130725263441921 /// 接口文档:https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/website-channel/list /// Authorization:tenant_access_token - /// 根据官网 ID 分页获取推广渠道列表。 + /// 根据官网 ID 获取推广渠道列表,支持分页查询。 /// 权限要求: /// hire:site /// hire:site:readonly @@ -21922,7 +22142,7 @@ System.Threading.Tasks.Task PostDriveV1FilesByFileTokenSubscribe /// /// 路径参数 /// 必填:是 - /// 官网 ID + /// 官网 ID,可通过[获取招聘官网列表](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/website/list)获取 /// 示例值:1618209327096 /// /// @@ -21948,7 +22168,7 @@ System.Threading.Tasks.Task PostDriveV1FilesByFileTokenSubscribe /// 接口ID:7097130725263458305 /// 接口文档:https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/website-channel/delete /// Authorization:tenant_access_token - /// 根据招聘官网 ID 和推广渠道 ID 删除招聘官网推广渠道。 + /// 根据招聘官网 ID 和推广渠道 ID 删除推广渠道。 /// 权限要求: /// hire:site /// @@ -21956,13 +22176,13 @@ System.Threading.Tasks.Task PostDriveV1FilesByFileTokenSubscribe /// /// 路径参数 /// 必填:是 - /// 官网 ID + /// 官网 ID,可通过[获取招聘官网列表](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/website/list)获取 /// 示例值:1618209327096 /// /// /// 路径参数 /// 必填:是 - /// 推广渠道 ID + /// 推广渠道 ID,可通过[获取推广渠道列表](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/website-channel/list)获取 /// 示例值:7085989097067563300 /// [HttpDelete("/open-apis/hire/v1/websites/{website_id}/channels/{channel_id}")] @@ -21975,7 +22195,7 @@ System.Threading.Tasks.Task DeleteHireV1WebsitesByWebsiteIdChann /// 接口ID:7097130725263474689 /// 接口文档:https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/website-channel/create /// Authorization:tenant_access_token - /// 根据招聘官网 ID 和推广渠道名称创建招聘官网推广渠道。 + /// 新建指定官网的推广渠道。每个官网可以新建多个推广渠道,每个推广渠道具有不同的推广链接和推广码。 /// 权限要求: /// hire:site /// @@ -21983,7 +22203,7 @@ System.Threading.Tasks.Task DeleteHireV1WebsitesByWebsiteIdChann /// /// 路径参数 /// 必填:是 - /// 官网 ID + /// 官网 ID,可通过[获取招聘官网列表](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/website/list)获取 /// 示例值:1618209327096 /// /// 请求体 @@ -21997,7 +22217,7 @@ System.Threading.Tasks.Task DeleteHireV1WebsitesByWebsiteIdChann /// 接口ID:7097130725263491073 /// 接口文档:https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/website-channel/update /// Authorization:tenant_access_token - /// 根据招聘官网 ID 和推广渠道 ID 更改推广渠道名称。 + /// 根据招聘官网 ID 和推广渠道 ID 更改推广渠道,仅支持修改推广渠道名称。 /// 权限要求: /// hire:site /// @@ -22005,13 +22225,13 @@ System.Threading.Tasks.Task DeleteHireV1WebsitesByWebsiteIdChann /// /// 路径参数 /// 必填:是 - /// 官网 ID + /// 官网 ID,通过[获取招聘官网列表](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/website/list)获取 /// 示例值:1618209327096 /// /// /// 路径参数 /// 必填:是 - /// 推广渠道 ID + /// 推广渠道 ID,可通过[获取推广渠道列表](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/website-channel/list)获取 /// 示例值:7085989097067563300 /// /// 请求体 @@ -23164,7 +23384,7 @@ System.Threading.Tasks.Task PostContactV3GroupByGroupIdMemberBat /// /// /// 必填:是 - /// 请求体中的 user_ids 和响应体中的 user_id 的员工ID类型 + /// 请求体中的 user_ids 和响应体中的 user_id 的员工ID类型。如果没有后台管理权限,可使用[通过手机号或邮箱获取用户 ID](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/batch_get_id) /// 示例值:employee_id /// /// employee_id:员工 employee ID,即[飞书管理后台](https://example.feishu.cn/admin/index) > 组织架构 > 成员与部门 > 成员详情中的用户 ID @@ -23190,7 +23410,7 @@ System.Threading.Tasks.Task PostContactV3GroupByGroupIdMemberBat /// /// /// 必填:是 - /// 请求体和响应体中的 user_id 的员工ID类型 + /// 请求体和响应体中的 user_id 的员工ID类型。如果没有后台管理权限,可使用[通过手机号或邮箱获取用户 ID](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/batch_get_id) /// 示例值:employee_id /// /// employee_id:员工 employee ID,即[飞书管理后台](https://example.feishu.cn/admin/contacts/departmentanduser) > 组织架构 > 成员与部门 > 成员详情中的用户 ID @@ -29668,6 +29888,8 @@ System.Threading.Tasks.Task PutContactV3FunctionalRolesByRoleIdA /// corehr:employment.job_level:write /// corehr:job_change.employment_custom_field:read /// corehr:job_change.remark:read + /// corehr:job_data.compensation_type:read + /// corehr:job_data.service_company:read /// /// /// @@ -29849,7 +30071,7 @@ System.Threading.Tasks.Task PutContactV3FunctionalRolesByRoleIdA /// 接口ID:7211423970042183684 /// 接口文档:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/offboarding/search /// Authorization:tenant_access_token - /// 该接口支持员工ID、离职审批发起时间和离职日期等字段搜索离职信息,可获取包括离职日期、离职原因、离职状态和流程审批状态等信息。 + /// 该接口支持根据员工ID、离职审批发起时间和离职日期等字段搜索离职信息,可获取包括离职日期、离职原因、离职状态和流程审批状态等信息。 /// 权限要求: /// corehr:offboarding:read /// corehr:offboarding:write @@ -32477,7 +32699,7 @@ System.Threading.Tasks.Task GetLingoV1FilesByFileTokenDownl /// 接口ID:7254814386694553602 /// 接口文档:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/probation/search /// Authorization:tenant_access_token - /// 搜索试用期信息 + /// 搜索试用期信息,创建试用期后立刻搜索,可能会存在 5s 左右延迟 /// 权限要求: /// corehr:probation:read /// corehr:probation:write @@ -32640,6 +32862,90 @@ System.Threading.Tasks.Task PatchCorehrV2ProbationAssessmentsByA System.Threading.Tasks.Task DeleteCorehrV2ProbationAssessmentsByAssessmentIdAsync( [PathQuery] string assessment_id); + /// + /// 【飞书人事(企业版)】发起转正 + /// 接口ID:7254814386694635522 + /// 接口文档:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/probation/submit + /// Authorization:tenant_access_token + /// 通过本接口可以为员工发起转正 + /// 权限要求: + /// corehr:probation:write + /// + /// 字段权限要求: + /// contact:user.employee_id:readonly + /// corehr:probation.assessment:read + /// corehr:probation.assessment:write + /// corehr:probation.custom_field:read + /// corehr:probation.custom_field:write + /// corehr:probation.notes:read + /// corehr:probation.notes:write + /// corehr:probation.self_review:read + /// corehr:probation.self_review:write + /// + /// + /// + /// 必填:否 + /// 根据 client_token 是否一致来判断是否为同一请求 + /// 示例值:6822122262122064111 + /// 默认值:null + /// + /// + /// 必填:否 + /// 用户 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 + /// + /// 请求体 + [HttpPost("/open-apis/corehr/v2/probation/submit")] + System.Threading.Tasks.Task> PostCorehrV2ProbationSubmitAsync( + [JsonContent] Corehr.PostCorehrV2ProbationSubmitBodyDto dto, + [PathQuery] string? client_token = null, + [PathQuery] string? user_id_type = "open_id"); + + /// + /// 【飞书人事(企业版)】撤销转正 + /// 接口ID:7254814386694651906 + /// 接口文档:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/probation/withdraw + /// Authorization:tenant_access_token + /// 可通过本接口撤销对员工之前发起的转正 + /// 权限要求: + /// corehr:probation:write + /// + /// 字段权限要求: + /// contact:user.employee_id:readonly + /// + /// + /// + /// 必填:否 + /// 根据 client_token 是否一致来判断是否为同一请求 + /// 示例值:6822122262122064111 + /// 默认值:null + /// + /// + /// 必填:否 + /// 用户 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 + /// + /// 请求体 + [HttpPost("/open-apis/corehr/v2/probation/withdraw")] + System.Threading.Tasks.Task PostCorehrV2ProbationWithdrawAsync( + [JsonContent] Corehr.PostCorehrV2ProbationWithdrawBodyDto dto, + [PathQuery] string? client_token = null, + [PathQuery] string? user_id_type = "open_id"); + /// /// 【审批】查看指定三方审批定义 /// 接口ID:7255160068449828892 @@ -34441,6 +34747,7 @@ System.Threading.Tasks.Task DeleteDriveV1FilesByFileTokenDeleteS /// 调用该接口以当前身份(应用或用户)为日程解绑已创建的会议群。 /// 权限要求: /// calendar:calendar + /// calendar:calendar.event:update /// /// /// @@ -34474,6 +34781,7 @@ System.Threading.Tasks.Task DeleteCalendarV4CalendarsByCalendarI /// 调用该接口以当前身份(应用或用户)为指定日程创建一个会议群。 /// 权限要求: /// calendar:calendar + /// calendar:calendar.event:update /// /// /// @@ -34496,6 +34804,34 @@ System.Threading.Tasks.Task DeleteCalendarV4CalendarsByCalendarI [PathQuery] string calendar_id, [PathQuery] string event_id); + /// + /// 【日历】创建会议纪要 + /// 接口ID:7263360328350760964 + /// 接口文档:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event-meeting_minute/create + /// Authorization:tenant_access_token、user_access_token + /// 调用该接口为指定的日程创建会议纪要。纪要以文档形式展示,成功创建后会返回纪要文档 URL。 + /// 权限要求: + /// calendar:calendar + /// calendar:calendar.event:update + /// + /// + /// + /// 路径参数 + /// 必填:是 + /// 日历 ID。调用[查询主日历信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/primary)接口,获取当前身份的主日历 ID。 + /// 示例值:feishu.cn_xxx@group.calendar.feishu.cn + /// + /// + /// 路径参数 + /// 必填:是 + /// 日程 ID。调用[搜索日程](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event/search)接口,在指定日历内搜索日程并获取日程 ID。 + /// 示例值:75d28f9b-e35c-4230-8a83-123_0 + /// + [HttpPost("/open-apis/calendar/v4/calendars/{calendar_id}/events/{event_id}/meeting_minute")] + System.Threading.Tasks.Task> PostCalendarV4CalendarsByCalendarIdEventsByEventIdMeetingMinuteAsync( + [PathQuery] string calendar_id, + [PathQuery] string event_id); + /// /// 【任务】将自定义字段加入资源 /// 接口ID:7270765454292189186 @@ -36728,6 +37064,7 @@ System.Threading.Tasks.Task PostImV2BizEntityTagRelationAsync( /// 调用该接口以当前身份(应用或用户)回复日程。 /// 权限要求: /// calendar:calendar + /// calendar:calendar.event:reply /// calendar:calendar.event:writeonly /// /// @@ -36762,6 +37099,7 @@ System.Threading.Tasks.Task PostCalendarV4CalendarsByCalendarIdE /// 权限要求: /// calendar:calendar /// calendar:calendar:readonly + /// calendar:calendar.event:read /// /// /// @@ -36985,6 +37323,7 @@ System.Threading.Tasks.Task PostCalendarV4CalendarsByCalendarIdE /// 权限要求: /// calendar:calendar /// calendar:calendar:readonly + /// calendar:calendar.event:read /// /// 字段权限要求: /// contact:user.employee_id:readonly @@ -37533,6 +37872,26 @@ System.Threading.Tasks.Task PostApaasV1ApprovalTasksByApprovalTa [PathQuery] string? user_id_type = "people_corehr_id", [PathQuery] string? department_id_type = "people_corehr_department_id"); + /// + /// 【飞书人事(企业版)】操作员工完成入职 + /// 接口ID:7357756972752699394 + /// 接口文档:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/pre_hire/complete + /// Authorization:tenant_access_token + /// 操作待入职员工完成入职,正式入职建立员工和公司/组织的雇佣关系 + /// 权限要求: + /// corehr:pre_hire:complete + /// + /// + /// + /// 路径参数 + /// 必填:是 + /// 待入职ID,可从[待入职列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/pre_hire/search)接口获取 + /// 示例值:7345005664477775407 + /// + [HttpPost("/open-apis/corehr/v2/pre_hires/{pre_hire_id}/complete")] + System.Threading.Tasks.Task> PostCorehrV2PreHiresByPreHireIdCompleteAsync( + [PathQuery] string pre_hire_id); + /// /// 【飞书人事(企业版)】更新待入职信息 /// 接口ID:7357756972752715778 @@ -37555,6 +37914,28 @@ System.Threading.Tasks.Task PostApaasV1ApprovalTasksByApprovalTa [PathQuery] string pre_hire_id, [JsonContent] Corehr.PatchCorehrV2PreHiresByPreHireIdBodyDto dto); + /// + /// 【飞书人事(企业版)】流转入职任务 + /// 接口ID:7357756972752732162 + /// 接口文档:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/pre_hire/transit_task + /// Authorization:tenant_access_token + /// 配置入职流程后,可通过本接口流转进行中的任务 + /// 权限要求: + /// corehr:pre_hire:transit_tasks + /// + /// + /// + /// 路径参数 + /// 必填:是 + /// 待入职ID,可从[待入职列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/pre_hire/search)接口获取 + /// 示例值:7345005664477775407 + /// + /// 请求体 + [HttpPost("/open-apis/corehr/v2/pre_hires/{pre_hire_id}/transit_task")] + System.Threading.Tasks.Task> PostCorehrV2PreHiresByPreHireIdTransitTaskAsync( + [PathQuery] string pre_hire_id, + [JsonContent] Corehr.PostCorehrV2PreHiresByPreHireIdTransitTaskBodyDto dto); + /// /// 【消息与群组】更新 URL 预览 /// 接口ID:7358413940747862020 @@ -38506,5 +38887,148 @@ System.Threading.Tasks.Task PostHireV1ApplicationsByApplicationI System.Threading.Tasks.Task> PostCorehrV1CommonDataMetaDataAddEnumOptionAsync( [JsonContent] FeishuPeople.PostCorehrV1CommonDataMetaDataAddEnumOptionBodyDto dto, [PathQuery] string? client_token = null); + + /// + /// 【飞书人事(企业版)】查询待入职信息 + /// 接口ID:7386487948991299587 + /// 接口文档:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/pre_hire/query + /// Authorization:tenant_access_token + /// 该接口用于根据待入职人员 ID(支持批量)查询待入职人员信息,信息包含姓名、手机号等个人信息和任职信息。 + /// - 延迟说明:数据库主从延迟 2s 以内,即:直接创建待入职后2s内调用此接口可能查询不到数据。 + /// - 性能说明:本接口返回数据量较多,查询时请控制每批次数量(<10)和适当减少查询字段数(<50) + /// 权限要求: + /// corehr:pre_hire:read_only + /// + /// 字段权限要求: + /// contact:user.employee_id:readonly + /// corehr:contract.company:read + /// corehr:contract.company:write + /// corehr:contract.period:read + /// corehr:contract.period:write + /// corehr:employment.compensation_type:read + /// corehr:employment.compensation_type:write + /// corehr:employment.custom_field:read + /// corehr:employment.has_offer_salary:read + /// corehr:employment.job_grade:read + /// corehr:employment.job_grade:write + /// corehr:employment.job_level:read + /// corehr:employment.job_level:write + /// corehr:employment.job:read + /// corehr:employment.non_compete_covenant:read + /// corehr:employment.non_compete_covenant:write + /// corehr:employment.pay_group:read + /// corehr:employment.position:read + /// corehr:employment.position:write + /// corehr:employment.recruitment_project_id:read + /// corehr:job_data.work_shift:read + /// corehr:person.address:read + /// corehr:person.address:write + /// corehr:person.bank_account:read + /// corehr:person.bank_account:write + /// corehr:person.born_country_region:read + /// corehr:person.born_country_region:write + /// corehr:person.custom_field:read + /// corehr:person.custom_field:write + /// corehr:person.date_entered_workforce:read + /// corehr:person.date_entered_workforce:write + /// corehr:person.date_of_birth:read + /// corehr:person.date_of_birth:write + /// corehr:person.dependent:read + /// corehr:person.dependent:write + /// corehr:person.education:read + /// corehr:person.education:write + /// corehr:person.email:read + /// corehr:person.email:write + /// corehr:person.emergency_contact:read + /// corehr:person.emergency_contact:write + /// corehr:person.gender:read + /// corehr:person.gender:write + /// corehr:person.hukou:read + /// corehr:person.hukou:write + /// corehr:person.is_disabled:read + /// corehr:person.is_disabled:write + /// corehr:person.is_old_alone:read + /// corehr:person.is_old_alone:write + /// corehr:person.legal_name:read + /// corehr:person.legal_name:write + /// corehr:person.marital_status:read + /// corehr:person.marital_status:write + /// corehr:person.martyr_family:read + /// corehr:person.martyr_family:write + /// corehr:person.national_id:read + /// corehr:person.national_id:write + /// corehr:person.native_region:read + /// corehr:person.native_region:write + /// corehr:person.passport_number:read + /// corehr:person.personal_profile:read + /// corehr:person.personal_profile:write + /// corehr:person.phone:read + /// corehr:person.phone:write + /// corehr:person.political_affiliation:read + /// corehr:person.race:read + /// corehr:person.religion:read + /// corehr:person.religion:write + /// corehr:person.resident_tax_custom_field:read + /// corehr:person.resident_tax_custom_field:write + /// corehr:person.resident_tax:read + /// corehr:person.resident_tax:write + /// corehr:person.work_experience:read + /// corehr:person.work_experience:write + /// corehr:pre_hire.abnormal_reason_field:read + /// corehr:pre_hire.check_in_data:read + /// corehr:pre_hire.company_manual_updated:read + /// corehr:pre_hire.company_sponsored_visa:read + /// corehr:pre_hire.cost_center:read + /// corehr:pre_hire.cost_center:write + /// corehr:pre_hire.flow_id:read + /// corehr:pre_hire.office_address:read + /// corehr:pre_hire.onboarding_address:read + /// corehr:pre_hire.suspected_rehiring:read + /// corehr:pre_hire.working_calendar:read + /// + /// + /// + /// 必填:是 + /// 分页大小,最大 10 + /// 示例值:10 + /// 默认值:10 + /// + /// + /// 必填:否 + /// 分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果 + /// 示例值:6891251722631890445 + /// 默认值:null + /// + /// + /// 必填:否 + /// 用户 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 类型 + /// 示例值:open_department_id + /// + /// open_department_id:以 open_department_id 来标识部门 + /// department_id:以 department_id 来标识部门 + /// people_corehr_department_id:以 people_corehr_department_id 来标识部门 + /// + /// 默认值:open_department_id + /// + /// 请求体 + [HttpPost("/open-apis/corehr/v2/pre_hires/query")] + System.Threading.Tasks.Task> PostCorehrV2PreHiresQueryAsync( + [JsonContent] Corehr.PostCorehrV2PreHiresQueryBodyDto dto, + [PathQuery] int page_size = 10, + [PathQuery] string? page_token = null, + [PathQuery] string? user_id_type = "open_id", + [PathQuery] string? department_id_type = "open_department_id"); } diff --git a/src/IFeishuUserApi.cs b/src/IFeishuUserApi.cs index c449c10d..83d21bfb 100644 --- a/src/IFeishuUserApi.cs +++ b/src/IFeishuUserApi.cs @@ -100,6 +100,8 @@ public interface IFeishuUserApi : IHttpApi /// 接口文档:https://open.feishu.cn/document/ukTMukTMukTM/ukjMzUjL5IzM14SOyMTN /// Authorization:tenant_access_token、user_access_token /// 设置单元格中数据的样式。支持设置字体、背景、边框等样式。 + /// 使用限制:- 单次设置的范围不可超过 5,000 行 100 列。 + /// - 在设置边框样式时,单次更新的单元格数量不可超过 30,000 个。 /// 权限要求: /// drive:drive /// sheets:spreadsheet @@ -247,6 +249,8 @@ public interface IFeishuUserApi : IHttpApi /// 接口文档:https://open.feishu.cn/document/ukTMukTMukTM/uATNzUjLwUzM14CM1MTN /// Authorization:tenant_access_token、user_access_token /// 拆分电子表格工作表中的单元格。 + /// 使用限制: + /// 单次操作范围不可超过 5,000 行、100 列。 /// 权限要求: /// drive:drive /// sheets:spreadsheet @@ -273,6 +277,9 @@ public interface IFeishuUserApi : IHttpApi /// 接口文档:https://open.feishu.cn/document/ukTMukTMukTM/uMTM4UjLzEDO14yMxgTN /// Authorization:user_access_token /// 调用该接口通过用户名关键词搜索其他用户的信息,包括用户头像、用户名、用户所在部门、用户 user_id 以及 open_id。 + /// 注意事项: + /// - 仅支持通过用户身份(user_access_token)调用该接口。 + /// - 无法搜索到外部企业或已离职的用户。 /// 权限要求: /// contact:user:search /// @@ -311,6 +318,9 @@ public interface IFeishuUserApi : IHttpApi /// 接口文档:https://open.feishu.cn/document/ukTMukTMukTM/ucjMzUjL3IzM14yNyMTN /// Authorization:tenant_access_token、user_access_token /// 该接口用于删除电子表格中的指定行或列。 + /// 使用限制: + /// - 单次调用该接口,最多支持删除 5000 行或列。 + /// - 一个工作表最少需有一行一列。你无法删除所有行或列。 /// 权限要求: /// drive:drive /// sheets:spreadsheet @@ -362,6 +372,9 @@ public interface IFeishuUserApi : IHttpApi /// 接口文档:https://open.feishu.cn/document/ukTMukTMukTM/uMjMzUjLzIzM14yMyMTN /// Authorization:tenant_access_token、user_access_token /// 在电子表格工作表的指定范围中,在空白位置中追加数据。例如,若指定范围参数 `range` 为 `6e5ed3!A1:B2`,该接口将会依次寻找 A1、A2、A3...单元格,在找到的第一个空白位置中写入数据。 + /// 使用限制: + /// - 单次写入范围不可超过 5,000 行、100 列。 + /// - 每个单元格不超过 50,000 字符,由于服务端会增加控制字符,因此推荐每个单元格不超过 40,000 字符。 /// 权限要求: /// drive:drive /// sheets:spreadsheet @@ -487,6 +500,7 @@ public interface IFeishuUserApi : IHttpApi /// 接口文档:https://open.feishu.cn/document/ukTMukTMukTM/uYjMzUjL2IzM14iNyMTN /// Authorization:tenant_access_token、user_access_token /// 该接口用于更新设置电子表格中行列的属性,包括是否隐藏行列和设置行高列宽。 + /// 使用限制:单次调用该接口,最多支持设置 5000 行或列。 /// 权限要求: /// drive:drive /// sheets:spreadsheet @@ -539,6 +553,10 @@ System.Threading.Tasks.Task PutSheetsV2SpreadsheetsBySpreadsheet /// 接口文档:https://open.feishu.cn/document/ukTMukTMukTM/uAzMzUjLwMzM14CMzMTN /// Authorization:tenant_access_token、user_access_token /// 批量设置单元格中数据的样式。支持设置字体、背景、边框等样式。 + /// 使用限制:- 单次设置的范围不可超过 5,000 行 100 列。 + /// - 在设置边框样式时,单次更新的单元格数量不可超过 30,000 个。 + /// 注意事项: + /// 在批量设置单元格时,当单元格在多个范围中时,单元格将应用请求体的最后一个样式。例如,对 A1:B2、B2:C3 分别设置样式,B2 单元格将应用 B2:C3 区域的样式。 /// 权限要求: /// drive:drive /// sheets:spreadsheet @@ -564,28 +582,36 @@ System.Threading.Tasks.Task PutSheetsV2SpreadsheetsBySpreadsheet /// 接口ID:6907569742383988738 /// 接口文档:https://open.feishu.cn/document/ukTMukTMukTM/ugDNzUjL4QzM14CO0MTN /// Authorization:tenant_access_token、user_access_token - /// 该接口用于根据 spreadsheetToken 和维度信息增加多个保护范围;单次操作不超过5000行或列。 - /// 仅支持设置保护行或保护列,暂不支持设置保护单元格 + /// 在电子表格工作表中设置多个保护范围,支持对行或列设置保护范围。 /// 权限要求: /// drive:drive /// sheets:spreadsheet /// /// - /// + /// /// 路径参数 /// 必填:是 - /// spreadsheet 的 token,获取方式见 [在线表格开发指南](https://open.feishu.cn/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/overview) + /// 电子表格的 token。可通过以下两种方式获取。了解更多,参考[电子表格概述](https://open.feishu.cn/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/overview)。 + /// - 电子表格的 URL:https://sample.feishu.cn/sheets/==Iow7sNNEphp3WbtnbCscPqabcef== + /// - 调用[获取文件夹中的文件清单](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/list) + /// **示例值**:"Iow7sNNEphp3WbtnbCscPqabcef" /// /// /// 必填:否 - /// 请求的用户id类型,可选open_id,union_id + /// 指定请求体中 users 字段对应的用户 ID 类型。可选值如下所示。了解更多,参考[用户身份概述](https://open.feishu.cn/document/home/user-identity-introduction/introduction)。可选值: + /// - `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) + /// **注意**: + /// 若要在请求体中传入 users 参数,user_id_type 参数必填。 /// 默认值:open_id /// + /// 请求体 /// 用户凭证 - [HttpPost("/open-apis/sheets/v2/spreadsheets/{spreadsheetToken}/protected_dimension")] - System.Threading.Tasks.Task PostSheetsV2SpreadsheetsBySpreadsheetTokenProtectedDimensionAsync( + [HttpPost("/open-apis/sheets/v2/spreadsheets/{spreadsheet_token}/protected_dimension")] + System.Threading.Tasks.Task> PostSheetsV2SpreadsheetsBySpreadsheetTokenProtectedDimensionAsync( UserAccessToken access_token, - [PathQuery] string spreadsheetToken, + [PathQuery] string spreadsheet_token, + [JsonContent] Ccm.Spec.PostSheetsV2SpreadsheetsBySpreadsheetTokenProtectedDimensionBodyDto dto, [PathQuery] string? user_id_type = "open_id"); /// @@ -618,6 +644,8 @@ System.Threading.Tasks.Task PostSheetsV2SpreadsheetsBySpreadshee /// 接口文档:https://open.feishu.cn/document/ukTMukTMukTM/uEjMzUjLxIzM14SMyMTN /// Authorization:tenant_access_token、user_access_token /// 向电子表格某个工作表的多个指定范围中写入数据。若指定范围已内有数据,将被新写入的数据覆盖。 + /// 使用限制:- 单次写入数据不得超过 5000 行、100列。 + /// - 每个单元格不超过 50,000 字符,由于服务端会增加控制字符,因此推荐每个单元格不超过 40,000 字符。 /// 权限要求: /// drive:drive /// sheets:spreadsheet @@ -645,6 +673,9 @@ System.Threading.Tasks.Task PostSheetsV2SpreadsheetsBySpreadshee /// 接口文档:https://open.feishu.cn/document/ukTMukTMukTM/uIjMzUjLyIzM14iMyMTN /// Authorization:tenant_access_token、user_access_token /// 在电子表格工作表的指定范围的起始位置上方增加若干行,并在该范围中填充数据。 + /// 使用限制: + /// - 单次写入数据不可超过 5,000 行、100 列。 + /// - 每个单元格不可超过 50,000 字符,由于服务端会增加控制字符,因此推荐每个单元格不超过 40,000 字符。 /// 权限要求: /// drive:drive /// sheets:spreadsheet @@ -672,6 +703,9 @@ System.Threading.Tasks.Task PostSheetsV2SpreadsheetsBySpreadshee /// 接口文档:https://open.feishu.cn/document/ukTMukTMukTM/ugTMzUjL4EzM14COxMTN /// Authorization:tenant_access_token、user_access_token /// 读取电子表格中单个指定范围的数据。 + /// 使用限制: + /// - 该接口返回数据的最大限制为 10 MB。 + /// - 该接口不支持获取跨表引用和数组公式的计算结果。 /// 权限要求: /// drive:drive /// drive:drive:readonly @@ -758,6 +792,8 @@ System.Threading.Tasks.Task PostSheetsV2SpreadsheetsBySpreadshee /// 接口文档:https://open.feishu.cn/document/ukTMukTMukTM/ukDNzUjL5QzM14SO0MTN /// Authorization:tenant_access_token、user_access_token /// 合并电子表格工作表中的单元格。 + /// 使用限制: + /// 单次操作范围不可超过 5,000 行、100 列。 /// 权限要求: /// drive:drive /// sheets:spreadsheet @@ -790,7 +826,7 @@ System.Threading.Tasks.Task PostSheetsV2SpreadsheetsBySpreadshee /// sheets:spreadsheet /// /// - /// + /// /// 路径参数 /// 必填:是 /// 电子表格的 token。可通过以下两种方式获取。了解更多,参考[电子表格概述](https://open.feishu.cn/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/overview)。 @@ -806,10 +842,10 @@ System.Threading.Tasks.Task PostSheetsV2SpreadsheetsBySpreadshee /// /// 请求体 /// 用户凭证 - [HttpPost("/open-apis/sheets/v2/spreadsheets/{spreadsheetToken}/sheets_batch_update")] + [HttpPost("/open-apis/sheets/v2/spreadsheets/{spreadsheet_token}/sheets_batch_update")] System.Threading.Tasks.Task> PostSheetsV2SpreadsheetsBySpreadsheetTokenSheetsBatchUpdate2Async( UserAccessToken access_token, - [PathQuery] string spreadsheetToken, + [PathQuery] string spreadsheet_token, [JsonContent] Ccm.Spec.PostSheetsV2SpreadsheetsBySpreadsheetTokenSheetsBatchUpdate2BodyDto dto, [PathQuery] string? user_id_type = "open_id"); @@ -819,6 +855,11 @@ System.Threading.Tasks.Task PostSheetsV2SpreadsheetsBySpreadshee /// 接口文档:https://open.feishu.cn/document/ukTMukTMukTM/uQTNzUjL0UzM14CN1MTN /// Authorization:tenant_access_token、user_access_token /// 该接口用于在云空间指定文件夹中创建电子表格或者多维表格。 + /// 使用限制: + /// - 云空间中根目录或文件夹的单层节点上限为 1500 个。超过此限制时,接口将返回 1062507 错误码。可通过将文件新建到不同文件夹中解决。 + /// - 云空间中所有层级的节点总和的上限为 40 万个。 + /// - 该接口不支持并发调用,且调用频率上限为 5QPS 且 10000次/天。否则会返回 1061045 错误码,可通过稍后重试解决。 + /// - 该接口不支持创建[文档](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-overview)(文档类型为 `docx`),如需创建文档,请调用[创建文档](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/document/create)接口。 /// 权限要求: /// docs:doc /// drive:drive @@ -844,6 +885,8 @@ System.Threading.Tasks.Task PostSheetsV2SpreadsheetsBySpreadshee /// 接口文档:https://open.feishu.cn/document/ukTMukTMukTM/uQjMzUjL0IzM14CNyMTN /// Authorization:tenant_access_token、user_access_token /// 该接口用于在电子表格的指定位置插入空白行或列。 + /// 使用限制: + /// 单次调用该接口,最多支持插入 5000 行或列。 /// 权限要求: /// drive:drive /// sheets:spreadsheet @@ -870,6 +913,9 @@ System.Threading.Tasks.Task PostSheetsV2SpreadsheetsBySpreadshee /// 接口文档:https://open.feishu.cn/document/ukTMukTMukTM/ukTMzUjL5EzM14SOxMTN /// Authorization:tenant_access_token、user_access_token /// 读取电子表格中多个指定范围的数据。 + /// 使用限制: + /// - 该接口返回数据的最大限制为 10 MB。 + /// - 该接口不支持获取跨表引用和数组公式的计算结果。 /// 权限要求: /// drive:drive /// drive:drive:readonly @@ -1030,6 +1076,9 @@ System.Threading.Tasks.Task PostSheetsV2SpreadsheetsBySpreadshee /// 接口文档:https://open.feishu.cn/document/ukTMukTMukTM/uUjMzUjL1IzM14SNyMTN /// Authorization:tenant_access_token、user_access_token /// 该接口用于在电子表格工作表中增加空白行或列。 + /// 使用限制: + /// - 单次调用该接口,最多支持增加 5000 行或列。 + /// - 该接口仅支持在工作表的行末尾或列末尾新增行列。要在指定位置新增行列,你需使用[插入行列](https://open.feishu.cn/document/ukTMukTMukTM/uQjMzUjL0IzM14CNyMTN)。 /// 权限要求: /// drive:drive /// sheets:spreadsheet @@ -1056,6 +1105,8 @@ System.Threading.Tasks.Task PostSheetsV2SpreadsheetsBySpreadshee /// 接口文档:https://open.feishu.cn/document/ukTMukTMukTM/uAjMzUjLwIzM14CMyMTN /// Authorization:tenant_access_token、user_access_token /// 向电子表格某个工作表的单个指定范围中写入数据。若指定范围已内有数据,将被新写入的数据覆盖。 + /// 使用限制:- 单次写入数据不得超过 5000 行、100列。 + /// - 每个单元格不超过 50,000 字符,由于服务端会增加控制字符,因此推荐每个单元格不超过 40,000 字符。 /// 权限要求: /// drive:drive /// sheets:spreadsheet @@ -1089,7 +1140,7 @@ System.Threading.Tasks.Task PostSheetsV2SpreadsheetsBySpreadshee /// sheets:spreadsheet /// /// - /// + /// /// 路径参数 /// 必填:是 /// 电子表格的 token。可通过以下两种方式获取。了解更多,参考[电子表格概述](https://open.feishu.cn/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/overview)。 @@ -1098,10 +1149,10 @@ System.Threading.Tasks.Task PostSheetsV2SpreadsheetsBySpreadshee /// /// 请求体 /// 用户凭证 - [HttpPost("/open-apis/sheets/v2/spreadsheets/{spreadsheetToken}/sheets_batch_update")] + [HttpPost("/open-apis/sheets/v2/spreadsheets/{spreadsheet_token}/sheets_batch_update")] System.Threading.Tasks.Task> PostSheetsV2SpreadsheetsBySpreadsheetTokenSheetsBatchUpdateAsync( UserAccessToken access_token, - [PathQuery] string spreadsheetToken, + [PathQuery] string spreadsheet_token, [JsonContent] Ccm.Spec.PostSheetsV2SpreadsheetsBySpreadsheetTokenSheetsBatchUpdateBodyDto dto); /// @@ -1374,9 +1425,10 @@ System.Threading.Tasks.Task PostDocV2ByDocTokenBatchUpdateAsync( /// 接口ID:6923123667871596572 /// 接口文档:https://open.feishu.cn/document/ukTMukTMukTM/uQTM5YjL0ETO24CNxkjN /// Authorization:tenant_access_token、user_access_token - /// 该接口用于根据保护范围ID查询详细的保护行列信息,最多支持同时查询5个ID。 - /// 1. 仅支持获取保护行或保护列,暂不支持获取保护单元格 - /// 2. 不支持获取包含多个区域的保护范围 + /// 获取电子表格工作表中指定保护范围的信息,包括保护的行列索引、支持编辑的用户 ID、保护范围的备注等。 + /// 使用限制: + /// - 单次调用该接口,最多支持获取 5 个保护范围的信息。 + /// - 不支持获取包含多个区域的保护范围。即如果一个保护范围中添加了多个区域,例如 B22:B26 和 C26:C28,则不支持调用该接口获取。 /// 权限要求: /// drive:drive /// sheets:spreadsheet @@ -1385,15 +1437,22 @@ System.Threading.Tasks.Task PostDocV2ByDocTokenBatchUpdateAsync( /// /// 路径参数 /// 必填:是 - /// spreadsheet 的 token,获取方式见[在线表格开发指南](https://open.feishu.cn/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/overview) + /// 电子表格的 token。可通过以下两种方式获取。了解更多,参考[电子表格概述](https://open.feishu.cn/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/overview)。 + /// - 电子表格的 URL:https://sample.feishu.cn/sheets/==Iow7sNNEphp3WbtnbCscPqabcef== + /// - 调用[获取文件夹中的文件清单](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/list) + /// **示例值**:"Iow7sNNEphp3WbtnbCscPqabcef" /// /// /// 必填:是 - /// 保护范围ID,可以通过[获取表格元数据](https://open.feishu.cn/document/ukTMukTMukTM/uETMzUjLxEzM14SMxMTN)接口获取,多个ID用逗号分隔,如xxxID1,xxxID2 + /// 保护范围的 ID,可通过[获取表格元数据](https://open.feishu.cn/document/ukTMukTMukTM/uETMzUjLxEzM14SMxMTN)接口获取。多个 ID 之间用逗号分隔。最多可传入 5 个 ID。 + /// **示例值**:"7379738014546812456,7379738014546812456" /// /// /// 必填:否 - /// 返回的用户类型,可选userId,openId,unionId,默认使用userId + /// 返回的用户 ID 的类型。默认为 `userId`,建议选择 `openId`。了解更多,参考[用户身份概述](https://open.feishu.cn/document/home/user-identity-introduction/introduction)。可选值: + /// - `userId`:即 `lark_id`,为全局 ID,标识用户的物理用户身份。 + /// - `openId`:标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。了解更多:[如何获取 Open ID](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid) + /// - `unionId`:标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的,在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID,应用开发商可以把同个用户在多个应用中的身份关联起来。了解更多:[如何获取 Union ID](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-union-id) /// 默认值:null /// /// 用户凭证 @@ -1409,7 +1468,8 @@ System.Threading.Tasks.Task PostDocV2ByDocTokenBatchUpdateAsync( /// 接口ID:6923123667871612956 /// 接口文档:https://open.feishu.cn/document/ukTMukTMukTM/uUTM5YjL1ETO24SNxkjN /// Authorization:tenant_access_token、user_access_token - /// 该接口用于根据保护范围ID修改保护范围,单次最多支持同时修改10个ID。 + /// 修改电子表格工作表中指定的保护范围。 + /// 使用限制:单次调用该接口,最多支持修改 10 个保护范围。 /// 权限要求: /// drive:drive /// sheets:spreadsheet @@ -1418,7 +1478,10 @@ System.Threading.Tasks.Task PostDocV2ByDocTokenBatchUpdateAsync( /// /// 路径参数 /// 必填:是 - /// sheet 的 token,获取方式见[在线表格开发指南](https://open.feishu.cn/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/overview) + /// 电子表格的 token。可通过以下两种方式获取。了解更多,参考[电子表格概述](https://open.feishu.cn/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/overview)。 + /// - 电子表格的 URL:https://sample.feishu.cn/sheets/==Iow7sNNEphp3WbtnbCscPqabcef== + /// - 调用[获取文件夹中的文件清单](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/list) + /// **示例值**:"Iow7sNNEphp3WbtnbCscPqabcef" /// /// 请求体 /// 用户凭证 @@ -1433,7 +1496,8 @@ System.Threading.Tasks.Task PostDocV2ByDocTokenBatchUpdateAsync( /// 接口ID:6923123667871629340 /// 接口文档:https://open.feishu.cn/document/ukTMukTMukTM/uYTM5YjL2ETO24iNxkjN /// Authorization:tenant_access_token、user_access_token - /// 该接口用于根据保护范围ID删除保护范围,最多支持同时删除10个ID。 + /// 根据保护范围 ID 删除保护范围。 + /// 注意事项:单次调用该接口,最多支持删除 10 个保护范围。 /// 权限要求: /// drive:drive /// sheets:spreadsheet @@ -1442,7 +1506,10 @@ System.Threading.Tasks.Task PostDocV2ByDocTokenBatchUpdateAsync( /// /// 路径参数 /// 必填:是 - /// sheet 的 token,获取方式见[在线表格开发指南](https://open.feishu.cn/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/overview) + /// 电子表格的 token。可通过以下两种方式获取。了解更多,参考[电子表格概述](https://open.feishu.cn/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/overview)。 + /// - 电子表格的 URL:https://sample.feishu.cn/sheets/==Iow7sNNEphp3WbtnbCscPqabcef== + /// - 调用[获取文件夹中的文件清单](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/list) + /// **示例值**:"Iow7sNNEphp3WbtnbCscPqabcef" /// /// 请求体 /// 用户凭证 @@ -2069,7 +2136,8 @@ System.Threading.Tasks.Task PostDocV2ByDocTokenBatchUpdateAsync( /// 接口ID:6943917246700257282 /// 接口文档:https://open.feishu.cn/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/datavalidation/delete-datavalidation /// Authorization:tenant_access_token、user_access_token - /// 该接口根据 spreadsheetToken 、range 移除选定数据范围单元格的下拉列表设置,但保留选项文本。单个删除范围不超过5000单元格。单次请求range最大数量100个。 + /// 删除电子表格工作表指定范围中下拉列表的设置,但仍保留选项文本。 + /// 使用限制:单次删除请求可指定多个范围,单个范围指定的单元格不可超过 5,000 个,范围的总数不可超过 100 个。 /// 权限要求: /// drive:drive /// sheets:spreadsheet @@ -2078,7 +2146,9 @@ System.Threading.Tasks.Task PostDocV2ByDocTokenBatchUpdateAsync( /// /// 路径参数 /// 必填:是 - /// spreadsheet 的 token,获取方式见[在线表格开发指南](https://open.feishu.cn/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/overview) + /// 电子表格的 token。可通过以下两种方式获取。了解更多,参考[电子表格概述](https://open.feishu.cn/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/overview)。 + /// - 电子表格的 URL:https://sample.feishu.cn/sheets/==Iow7sNNEphp3WbtnbCscPqabcef== + /// - 调用[获取文件夹中的文件清单](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/list) /// /// 请求体 /// 用户凭证 @@ -2093,7 +2163,9 @@ System.Threading.Tasks.Task PostDocV2ByDocTokenBatchUpdateAsync( /// 接口ID:6943917246700290050 /// 接口文档:https://open.feishu.cn/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/datavalidation/set-dropdown /// Authorization:tenant_access_token、user_access_token - /// 该接口根据 spreadsheetToken 、range 和下拉列表属性给单元格设置下拉列表规则;单次设置范围不超过5000行,100列。当一个数据区域中已有数据,支持将有效数据直接转为选项。 + /// 在电子表格工作表中为指定区域添加下拉列表选项,并设置下拉列表的属性,包括是否支持多选、设置下拉选项样式等。若一个数据区域中已有数据,支持将有效数据直接转为下拉列表中的选项。 + /// 使用限制: + /// 单次调用该接口,最多支持为 5,000 行、100 列设置下拉列表。 /// 权限要求: /// drive:drive /// sheets:spreadsheet @@ -2102,12 +2174,14 @@ System.Threading.Tasks.Task PostDocV2ByDocTokenBatchUpdateAsync( /// /// 路径参数 /// 必填:是 - /// spreadsheet 的 token,获取方式见[在线表格开发指南](https://open.feishu.cn/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/overview) + /// 电子表格的 token。可通过以下两种方式获取。了解更多,参考[电子表格概述](https://open.feishu.cn/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/overview)。 + /// - 电子表格的 URL:https://sample.feishu.cn/sheets/==Iow7sNNEphp3WbtnbCscPqabcef== + /// - 调用[获取文件夹中的文件清单](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/list) /// /// 请求体 /// 用户凭证 [HttpPost("/open-apis/sheets/v2/spreadsheets/{spreadsheetToken}/dataValidation")] - System.Threading.Tasks.Task PostSheetsV2SpreadsheetsBySpreadsheetTokenDataValidationAsync( + System.Threading.Tasks.Task> PostSheetsV2SpreadsheetsBySpreadsheetTokenDataValidationAsync( UserAccessToken access_token, [PathQuery] string spreadsheetToken, [JsonContent] Ccm.Spec.PostSheetsV2SpreadsheetsBySpreadsheetTokenDataValidationBodyDto dto); @@ -2117,7 +2191,9 @@ System.Threading.Tasks.Task PostSheetsV2SpreadsheetsBySpreadshee /// 接口ID:6943917246700306434 /// 接口文档:https://open.feishu.cn/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/datavalidation/query-datavalidation /// Authorization:tenant_access_token、user_access_token - /// 该接口根据 spreadsheetToken 、range 查询range内的下拉列表设置信息;单次查询范围不超过5000行,100列。 + /// 查询电子表格工作表中指定范围的下拉列表的设置信息。 + /// 使用限制: + /// 单次查询范围不得超过 5000 行、100列。 /// 权限要求: /// drive:drive /// sheets:spreadsheet @@ -2126,15 +2202,19 @@ System.Threading.Tasks.Task PostSheetsV2SpreadsheetsBySpreadshee /// /// 路径参数 /// 必填:是 - /// spreadsheet 的 token,获取方式见 [在线表格开发指南](https://open.feishu.cn/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/overview) + /// 电子表格的 token。可通过以下两种方式获取。了解更多,参考[电子表格概述](https://open.feishu.cn/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/overview)。 + /// - 电子表格的 URL:https://sample.feishu.cn/sheets/==Iow7sNNEphp3WbtnbCscPqabcef== + /// - 调用[获取文件夹中的文件清单](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/list) /// /// /// 必填:是 - /// 查询范围,包含 sheetId 与单元格范围两部分,目前支持四种索引方式,详见[在线表格开发指南](https://open.feishu.cn/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/overview) + /// 查询范围。格式为 `<sheetId>!<开始位置>:<结束位置>`。其中: + /// - `sheetId` 为工作表 ID,通过[获取工作表](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet/query) 获取 + /// - `<开始位置>:<结束位置>` 为工作表中单元格的范围,数字表示行索引,字母表示列索引。如 `A2:B2` 表示该工作表第 2 行的 A 列到 B 列。`range`支持四种写法,详情参考[电子表格概述](https://open.feishu.cn/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/overview) /// /// /// 必填:是 - /// 固定为"list",表示下拉列表 + /// 数据验证类型。取固定值 "list",表示下拉列表。 /// /// 用户凭证 [HttpGet("/open-apis/sheets/v2/spreadsheets/{spreadsheetToken}/dataValidation")] @@ -2149,7 +2229,7 @@ System.Threading.Tasks.Task PostSheetsV2SpreadsheetsBySpreadshee /// 接口ID:6943917246700322818 /// 接口文档:https://open.feishu.cn/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/datavalidation/update-datavalidation /// Authorization:tenant_access_token、user_access_token - /// 该接口根据 spreadsheetToken 、sheetId、dataValidationId 更新下拉列表的属性。 + /// 更新电子表格工作表中单个下拉列表的设置,支持更新下拉列表的选项和属性,包括是否支持多选、下拉选项的样式等。 /// 权限要求: /// drive:drive /// sheets:spreadsheet @@ -2158,17 +2238,19 @@ System.Threading.Tasks.Task PostSheetsV2SpreadsheetsBySpreadshee /// /// 路径参数 /// 必填:是 - /// spreadsheet 的 token,获取方式见[在线表格开发指南](https://open.feishu.cn/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/overview) + /// 电子表格的 token。可通过以下两种方式获取。了解更多,参考[电子表格概述](https://open.feishu.cn/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/overview)。 + /// - 电子表格的 URL:https://sample.feishu.cn/sheets/==Iow7sNNEphp3WbtnbCscPqabcef== + /// - 调用[获取文件夹中的文件清单](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/list) /// /// /// 路径参数 /// 必填:是 - /// 子sheet唯一识别参数 + /// 电子表格工作表的 ID。调用[获取工作表](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet/query)获取 ID。 /// /// /// 路径参数 /// 必填:是 - /// sheet中下拉列表的唯一标示id + /// 电子表格工作表中下拉列表的 ID。调用[查询下拉列表](https://open.feishu.cn/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/datavalidation/query-datavalidation)获取 ID。 /// /// 请求体 /// 用户凭证 @@ -3319,6 +3401,7 @@ System.Threading.Tasks.Task PutImV1ChatsByChatIdModerationAsync( /// 权限要求: /// calendar:calendar /// calendar:calendar:readonly + /// calendar:calendar.event:read /// /// 字段权限要求: /// contact:user.employee_id:readonly @@ -3396,6 +3479,7 @@ System.Threading.Tasks.Task PutImV1ChatsByChatIdModerationAsync( /// 权限要求: /// calendar:calendar /// calendar:calendar:readonly + /// calendar:calendar.event:read /// /// /// @@ -3418,6 +3502,7 @@ System.Threading.Tasks.Task PostCalendarV4CalendarsByCalendarIdE /// 调用该接口以当前身份(应用或用户)订阅指定的日历。 /// 权限要求: /// calendar:calendar + /// calendar:calendar:subscribe /// /// /// @@ -3445,6 +3530,7 @@ System.Threading.Tasks.Task PostCalendarV4CalendarsByCalendarIdE /// 权限要求: /// calendar:calendar /// calendar:calendar:readonly + /// calendar:calendar.event:read /// /// 字段权限要求: /// contact:user.employee_id:readonly @@ -3537,6 +3623,7 @@ System.Threading.Tasks.Task PostCalendarV4CalendarsByCalendarIdE /// 调用该接口以当前身份(应用或用户)为指定日历添加访问控制,即日历成员权限。 /// 权限要求: /// calendar:calendar + /// calendar:calendar.acl:create /// /// 字段权限要求: /// contact:user.employee_id:readonly @@ -3580,6 +3667,7 @@ System.Threading.Tasks.Task PostCalendarV4CalendarsByCalendarIdE /// 调用该接口以当前身份(应用或用户)删除指定日程的一个或多个参与人。 /// 权限要求: /// calendar:calendar + /// calendar:calendar.event:update /// /// 字段权限要求: /// contact:user.employee_id:readonly @@ -3630,6 +3718,7 @@ System.Threading.Tasks.Task PostCalendarV4CalendarsByCalendarIdE /// 权限要求: /// calendar:calendar /// calendar:calendar:readonly + /// calendar:calendar.event:read /// /// 字段权限要求: /// contact:user.employee_id:readonly @@ -3699,6 +3788,7 @@ System.Threading.Tasks.Task PostCalendarV4CalendarsByCalendarIdE /// 调用该接口通过关键字搜索日历,搜索结果为标题或描述包含关键字的公共日历或用户主日历。 /// 权限要求: /// calendar:calendar + /// calendar:calendar:read /// calendar:calendar:readonly /// /// @@ -3731,6 +3821,7 @@ System.Threading.Tasks.Task PostCalendarV4CalendarsByCalendarIdE /// 调用该接口分页查询当前身份(应用或用户)的日历列表。 /// 权限要求: /// calendar:calendar + /// calendar:calendar:read /// calendar:calendar:readonly /// /// @@ -3770,6 +3861,7 @@ System.Threading.Tasks.Task PostCalendarV4CalendarsByCalendarIdE /// 权限要求: /// calendar:calendar /// calendar:calendar:readonly + /// calendar:calendar.event:read /// /// 字段权限要求: /// contact:user.employee_id:readonly @@ -3843,6 +3935,7 @@ System.Threading.Tasks.Task PostCalendarV4CalendarsByCalendarIdE /// 权限要求: /// calendar:calendar /// calendar:calendar:readonly + /// calendar:calendar.free_busy:read /// /// 字段权限要求: /// contact:user.employee_id:readonly @@ -3893,6 +3986,7 @@ System.Threading.Tasks.Task PostCalendarV4CalendarsByCalendarIdE /// 调用该接口以当前身份(应用或用户)删除指定日历内的某一访问控制,即成员权限。 /// 权限要求: /// calendar:calendar + /// calendar:calendar.acl:delete /// /// /// @@ -3927,6 +4021,7 @@ System.Threading.Tasks.Task DeleteCalendarV4CalendarsByCalendarI /// 调用该接口以当前身份(应用或用户)删除指定日历上的一个日程。 /// 权限要求: /// calendar:calendar + /// calendar:calendar.event:delete /// /// /// @@ -3971,6 +4066,7 @@ System.Threading.Tasks.Task DeleteCalendarV4CalendarsByCalendarI /// 调用该接口以当前身份(应用或用户)查询指定日历的信息。 /// 权限要求: /// calendar:calendar + /// calendar:calendar:read /// calendar:calendar:readonly /// /// @@ -3998,6 +4094,7 @@ System.Threading.Tasks.Task DeleteCalendarV4CalendarsByCalendarI /// 调用该接口以当前身份(应用或用户)删除某一指定的共享日历。 /// 权限要求: /// calendar:calendar + /// calendar:calendar:delete /// /// /// @@ -4025,6 +4122,7 @@ System.Threading.Tasks.Task DeleteCalendarV4CalendarsByCalendarI /// 权限要求: /// calendar:calendar /// calendar:calendar:readonly + /// calendar:calendar.acl:read /// /// /// @@ -4051,6 +4149,7 @@ System.Threading.Tasks.Task PostCalendarV4CalendarsByCalendarIdA /// 调用该接口以当前身份(应用或用户)更新指定日历上的一个日程,包括日程标题、描述、开始与结束时间、视频会议以及日程地点等信息。 /// 权限要求: /// calendar:calendar + /// calendar:calendar.event:update /// /// 字段权限要求: /// contact:user.employee_id:readonly @@ -4100,6 +4199,7 @@ System.Threading.Tasks.Task PostCalendarV4CalendarsByCalendarIdA /// 调用该接口为当前用户身份订阅[日历变更事件](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/events/changed)。 /// 权限要求: /// calendar:calendar + /// calendar:calendar:read /// calendar:calendar:readonly /// /// @@ -4116,6 +4216,7 @@ System.Threading.Tasks.Task PostCalendarV4CalendarsSubscriptionA /// 调用该接口为当前身份(应用或用户)创建一个共享日历。 /// 权限要求: /// calendar:calendar + /// calendar:calendar:create /// /// /// 请求体 @@ -4133,6 +4234,7 @@ System.Threading.Tasks.Task PostCalendarV4CalendarsSubscriptionA /// 调用该接口以当前身份(应用或用户)取消指定日历的订阅状态。 /// 权限要求: /// calendar:calendar + /// calendar:calendar:subscribe /// /// /// @@ -4160,6 +4262,7 @@ System.Threading.Tasks.Task PostCalendarV4CalendarsByCalendarIdU /// 权限要求: /// calendar:calendar /// calendar:calendar:readonly + /// calendar:calendar.event:read /// /// 字段权限要求: /// contact:user.employee_id:readonly @@ -4213,6 +4316,7 @@ System.Threading.Tasks.Task PostCalendarV4CalendarsByCalendarIdU /// 调用该接口以当前身份(应用或用户)为指定日程添加一个或多个参与人,参与人类型包括用户、群组、会议室以及邮箱。 /// 权限要求: /// calendar:calendar + /// calendar:calendar.event:update /// /// 字段权限要求: /// contact:user.employee_id:readonly @@ -4262,6 +4366,7 @@ System.Threading.Tasks.Task PostCalendarV4CalendarsByCalendarIdU /// 调用该接口以当前身份(应用或用户)修改指定日历的标题、描述、公开范围等信息。 /// 权限要求: /// calendar:calendar + /// calendar:calendar:update /// /// /// @@ -4291,6 +4396,7 @@ System.Threading.Tasks.Task PostCalendarV4CalendarsByCalendarIdU /// 权限要求: /// calendar:calendar /// calendar:calendar:readonly + /// calendar:calendar.acl:read /// /// 字段权限要求: /// contact:user.employee_id:readonly @@ -8070,6 +8176,7 @@ System.Threading.Tasks.Task DeleteTaskV1TasksByTaskIdCollaborato /// 调用该接口以当前身份(应用或用户)在指定日历上创建一个日程。 /// 权限要求: /// calendar:calendar + /// calendar:calendar.event:create /// /// 字段权限要求: /// contact:user.employee_id:readonly @@ -10041,6 +10148,7 @@ System.Threading.Tasks.Task DeleteOkrV1ProgressRecordsByProgress /// Authorization:tenant_access_token、user_access_token /// 调用该接口获取当前身份(应用或用户)的主日历信息。 /// 权限要求: + /// calendar:calendar:read /// calendar:calendar:readonly /// /// 字段权限要求: @@ -12467,6 +12575,7 @@ System.Threading.Tasks.Task PatchSheetsV3SpreadsheetsBySpreadshe /// 调用该接口为当前用户身份取消订阅[日历变更事件](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/events/changed)。 /// 权限要求: /// calendar:calendar + /// calendar:calendar:read /// calendar:calendar:readonly /// /// @@ -12484,6 +12593,7 @@ System.Threading.Tasks.Task PostCalendarV4CalendarsUnsubscriptio /// 权限要求: /// calendar:calendar /// calendar:calendar:readonly + /// calendar:calendar.acl:read /// /// /// @@ -12511,6 +12621,7 @@ System.Threading.Tasks.Task PostCalendarV4CalendarsByCalendarIdA /// 权限要求: /// calendar:calendar /// calendar:calendar:readonly + /// calendar:calendar.event:read /// /// /// @@ -13092,6 +13203,9 @@ System.Threading.Tasks.Task DeleteDriveV1FilesByFileTokenVersion /// Authorization:user_access_token /// 通过 `user_access_token` 获取登录用户的信息。 /// 字段权限要求: + /// contact:contact:access_as_app + /// contact:contact:readonly + /// contact:contact:readonly_as_app /// contact:user.email:readonly /// contact:user.employee_id:readonly /// contact:user.employee:readonly @@ -16139,6 +16253,7 @@ System.Threading.Tasks.Task DeleteDriveV1FilesByFileTokenDeleteS /// 调用该接口以当前身份(应用或用户)为日程解绑已创建的会议群。 /// 权限要求: /// calendar:calendar + /// calendar:calendar.event:update /// /// /// @@ -16174,6 +16289,7 @@ System.Threading.Tasks.Task DeleteCalendarV4CalendarsByCalendarI /// 调用该接口以当前身份(应用或用户)为指定日程创建一个会议群。 /// 权限要求: /// calendar:calendar + /// calendar:calendar.event:update /// /// /// @@ -16198,6 +16314,36 @@ System.Threading.Tasks.Task DeleteCalendarV4CalendarsByCalendarI [PathQuery] string calendar_id, [PathQuery] string event_id); + /// + /// 【日历】创建会议纪要 + /// 接口ID:7263360328350760964 + /// 接口文档:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event-meeting_minute/create + /// Authorization:tenant_access_token、user_access_token + /// 调用该接口为指定的日程创建会议纪要。纪要以文档形式展示,成功创建后会返回纪要文档 URL。 + /// 权限要求: + /// calendar:calendar + /// calendar:calendar.event:update + /// + /// + /// + /// 路径参数 + /// 必填:是 + /// 日历 ID。调用[查询主日历信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/primary)接口,获取当前身份的主日历 ID。 + /// 示例值:feishu.cn_xxx@group.calendar.feishu.cn + /// + /// + /// 路径参数 + /// 必填:是 + /// 日程 ID。调用[搜索日程](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event/search)接口,在指定日历内搜索日程并获取日程 ID。 + /// 示例值:75d28f9b-e35c-4230-8a83-123_0 + /// + /// 用户凭证 + [HttpPost("/open-apis/calendar/v4/calendars/{calendar_id}/events/{event_id}/meeting_minute")] + System.Threading.Tasks.Task> PostCalendarV4CalendarsByCalendarIdEventsByEventIdMeetingMinuteAsync( + UserAccessToken access_token, + [PathQuery] string calendar_id, + [PathQuery] string event_id); + /// /// 【任务】将自定义字段加入资源 /// 接口ID:7270765454292189186 @@ -17267,6 +17413,7 @@ System.Threading.Tasks.Task DeleteTaskV2AttachmentsByAttachmentG /// 调用该接口以当前身份(应用或用户)回复日程。 /// 权限要求: /// calendar:calendar + /// calendar:calendar.event:reply /// calendar:calendar.event:writeonly /// /// @@ -17303,6 +17450,7 @@ System.Threading.Tasks.Task PostCalendarV4CalendarsByCalendarIdE /// 权限要求: /// calendar:calendar /// calendar:calendar:readonly + /// calendar:calendar.event:read /// /// /// @@ -17591,6 +17739,7 @@ System.Threading.Tasks.Task DeleteAcsV1VisitorsByVisitorIdAsync( /// 权限要求: /// calendar:calendar /// calendar:calendar:readonly + /// calendar:calendar.event:read /// /// 字段权限要求: /// contact:user.employee_id:readonly