【会议室】、【日历】、【飞书人事】接口更新

【OKR】新增查询复盘信息 Signed-off-by: Vicente.Yu <^@^>
vicenteyu · Apr 11, 2024 · 569ec2e · 569ec2e
1 parent 1aa4464
commit 569ec2e
Show file tree

Hide file tree

Showing 61 changed files with 2,493 additions and 1,951 deletions.
diff --git a/TenantAccessList.md b/TenantAccessList.md
diff --git a/UserAccessList.md b/UserAccessList.md
diff --git a/src/Calendar.Spec/PostCalendarV4CalendarsByCalendarIdAclsBodyDto.cs b/src/Calendar.Spec/PostCalendarV4CalendarsByCalendarIdAclsBodyDto.cs
diff --git a/src/Calendar.Spec/PostCalendarV4CalendarsByCalendarIdAclsResponseDto.cs b/src/Calendar.Spec/PostCalendarV4CalendarsByCalendarIdAclsResponseDto.cs
diff --git a/src/Calendar.Spec/PostCalendarV4TimeoffEventsBodyDto.cs b/src/Calendar.Spec/PostCalendarV4TimeoffEventsBodyDto.cs
diff --git a/src/Calendar.Spec/PostCalendarV4TimeoffEventsResponseDto.cs b/src/Calendar.Spec/PostCalendarV4TimeoffEventsResponseDto.cs
diff --git a/...V4CalendarsByCalendarIdAclsResponseDto.cs → ...V4CalendarsByCalendarIdAclsResponseDto.cs b/...V4CalendarsByCalendarIdAclsResponseDto.cs → ...V4CalendarsByCalendarIdAclsResponseDto.cs
@@ -1,72 +1,75 @@
-namespace FeishuNetSdk.Calendar.Spec;
+namespace FeishuNetSdk.Calendar;
 /// <summary>
 /// 获取访问控制列表 响应体
-/// <para>该接口用于以当前身份（应用 / 用户）获取日历的控制权限列表。</para>
-/// <para>身份由 Header Authorization 的 Token 类型决定。</para>
+/// <para>调用该接口以当前身份（应用或用户）获取指定日历的访问控制列表。</para>
 /// <para>接口ID：6953067803433009153</para>
 /// <para>文档地址：https://open.feishu.cn/document/server-docs/calendar-v4/calendar-acl/list</para>
 /// <para>JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fuAjLw4CM%2fukTMukTMukTM%2freference%2fcalendar-v4%2fcalendar-acl%2flist</para>
 /// </summary>
 public record GetCalendarV4CalendarsByCalendarIdAclsResponseDto
 {
     /// <summary>
-    /// <para>入参日历对应的acl列表</para>
+    /// <para>日历对应的访问控制列表。</para>
     /// <para>必填：否</para>
     /// </summary>
     [JsonPropertyName("acls")]
     public CalendarAcl[]? Acls { get; set; }
 
-    /// <summary></summary>
+    /// <summary>
+    /// <para>日历对应的访问控制列表。</para>
+    /// </summary>
     public record CalendarAcl
     {
         /// <summary>
-        /// <para>acl资源ID。参见[ACL ID说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-acl/introduction)</para>
-        /// <para>必填：否</para>
+        /// <para>访问控制 ID。该 ID 在单个日历实体内唯一，不同日历实体可能存在重复的访问控制 ID。</para>
+        /// <para>必填：是</para>
+        /// <para>示例值：user_xxxxxx</para>
         /// </summary>
         [JsonPropertyName("acl_id")]
-        public string? AclId { get; set; }
+        public string AclId { get; set; } = string.Empty;
 
         /// <summary>
-        /// <para>对日历的访问权限</para>
-        /// <para>**可选值有**：</para>
-        /// <para>unknown:未知权限,free_busy_reader:游客，只能看到忙碌/空闲信息,reader:订阅者，查看所有日程详情,writer:编辑者，创建及修改日程,owner:管理员，管理日历及共享设置</para>
-        /// <para>必填：否</para>
+        /// <para>对日历的访问权限。</para>
+        /// <para>必填：是</para>
+        /// <para>示例值：writer</para>
         /// <para>可选值：<list type="bullet">
-        /// <item>unknown：未知权限</item>
-        /// <item>free_busy_reader：游客，只能看到忙碌/空闲信息</item>
-        /// <item>reader：订阅者，查看所有日程详情</item>
-        /// <item>writer：编辑者，创建及修改日程</item>
-        /// <item>owner：管理员，管理日历及共享设置</item>
+        /// <item>unknown：未知权限。</item>
+        /// <item>free_busy_reader：游客，只能看到忙碌、空闲信息。</item>
+        /// <item>reader：订阅者，可查看所有日程详情。</item>
+        /// <item>writer：编辑者，可创建及修改日程。</item>
+        /// <item>owner：管理员，可管理日历及共享设置。</item>
         /// </list></para>
         /// </summary>
         [JsonPropertyName("role")]
-        public string? Role { get; set; }
+        public string Role { get; set; } = string.Empty;
 
         /// <summary>
-        /// <para>权限范围</para>
-        /// <para>必填：否</para>
+        /// <para>权限生效范围。</para>
+        /// <para>必填：是</para>
         /// </summary>
         [JsonPropertyName("scope")]
-        public AclScope? Scope { get; set; }
+        public AclScope Scope { get; set; } = new();
 
-        /// <summary></summary>
+        /// <summary>
+        /// <para>权限生效范围。</para>
+        /// </summary>
         public record AclScope
         {
             /// <summary>
-            /// <para>权限类型，当type为User时，值为open_id/user_id/union_id</para>
-            /// <para>**可选值有**：</para>
-            /// <para>user:用户</para>
-            /// <para>必填：否</para>
+            /// <para>权限生效范围的类型。</para>
+            /// <para>必填：是</para>
+            /// <para>示例值：user</para>
             /// <para>可选值：<list type="bullet">
             /// <item>user：用户</item>
             /// </list></para>
             /// </summary>
             [JsonPropertyName("type")]
-            public string? Type { get; set; }
+            public string Type { get; set; } = string.Empty;
 
             /// <summary>
-            /// <para>用户ID，参见[用户相关的 ID 概念](https://open.feishu.cn/document/home/user-identity-introduction/introduction)</para>
+            /// <para>用户 ID，更多介绍可参见[用户相关的 ID 概念](https://open.feishu.cn/document/home/user-identity-introduction/introduction)。</para>
             /// <para>必填：否</para>
+            /// <para>示例值：ou_xxxxxx</para>
             /// </summary>
             [JsonPropertyName("user_id")]
             public string? UserId { get; set; }
@@ -76,13 +79,15 @@ public record AclScope
     /// <summary>
     /// <para>是否还有更多项</para>
     /// <para>必填：否</para>
+    /// <para>示例值：false</para>
     /// </summary>
     [JsonPropertyName("has_more")]
     public bool? HasMore { get; set; }
 
     /// <summary>
     /// <para>分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token</para>
     /// <para>必填：否</para>
+    /// <para>示例值：xxx</para>
     /// </summary>
     [JsonPropertyName("page_token")]
     public string? PageToken { get; set; }